Glossary

The terms used across these docs, defined the way we use them.

Terms

API keyA tenant-scoped credential (mba_…) created in Settings → API keys. Identifies the tenant and carries its scopes.
TenantA business account. Each has its own data; a key can only read its own tenant.
ApplicationA product a tenant runs (an id + type, e.g. ppaws + mypetparlorapp).
ScopeA named permission a key must hold to perform a read (e.g. ReadCustomer).
Subscription keyThe API Management gateway key sent as Ocp-Apim-Subscription-Key. Not secret.
EnvelopeThe JSON wrapper every response uses: { success, message, data }.
OperationOne HTTP method + path in the API; each has a unique operationId.
StampA regional deployment that hosts tenants. A tenant lives on exactly one stamp.
PaginateWhether a list is split into pages. paginate=false (CLI --all) returns every row.
Was this page helpful?