# MyBusiness App Developer Documentation > Read-only REST API and `mba-cli` for MyBusiness App. Authenticate with a tenant API key and the API Management subscription key — both surfaces expose the same API. ## Usage This documentation is proprietary to MyBusinessApp (Pty) Ltd. Agents and developers may read it, use it to integrate with the API, and index it for discovery and grounding; do not republish it as your own. Use of the API is governed by the API terms at https://mybusinessapp.co.za/terms#api. API base URL: `https://mpp-api-mybusinessapp-san.azure-api.net/v2` Public subscription key (Ocp-Apim-Subscription-Key): `4fb0f9a3b14a44e98698e80cef2aebeb` API version: `3.55.133` ## Authentication > Every request needs a tenant API key and the API Management subscription key. There is no per-user login. ### Credentials | Header | Value | Purpose | | --- | --- | --- | | `x-mba-api-key` | `mba_…` | Tenant + scopes (the auth boundary). | | `Ocp-Apim-Subscription-Key` | `4fb0f9a3b14a44e98698e80cef2aebeb` | Public gateway key — same for every caller; only gates at APIM. | ### Get started 1. Open **Settings → API keys** (available in every product) and create a key with the scopes the integration needs (least privilege). The full value (`mba_…`) is shown once. 2. Send both headers. The subscription key below is public and identical for every caller: ```bash curl "$MBA_API_BASE_URL/customers" \ -H "x-mba-api-key: $MBA_API_KEY" \ -H "Ocp-Apim-Subscription-Key: 4fb0f9a3b14a44e98698e80cef2aebeb" ``` ### Tenant scoping The tenant is taken from the key, never from the request — a product key can only ever read its own tenant. The **Studio (system)** key is the one exception: it may target another application by adding `x-mba-application-id` and `x-mba-application-type` together. Any other key that names a different tenant is rejected with `403`. ### Scopes A key carries a set of scopes chosen at creation. A read without the required scope fails and the API names the missing scope — read it and grant exactly that. ```json { "success": false, "message": "API key does not have the required scope: ReadCustomer" } ``` ### Errors - `401` — missing, malformed, expired, or inactive API key. - `403` — the key lacks the required scope, is outside its IP allowlist, or tried to name another tenant. - `429` — rate limited (per-key limit set on the key). ### Security - Never embed an API key in a browser or mobile app — proxy through your server. - Grant the narrowest scopes that satisfy the task. - Set an IP allowlist on the key where the caller has a stable egress IP. - Rotate keys periodically, and revoke any that may have leaked. ## Pagination & filtering > List endpoints are paginated. Pass page and limit, or turn pagination off to fetch everything in one request. ### Pagination List endpoints accept: - `page` — 1-based page number (default `1`). - `limit` — rows per page (default `20`). - `paginate=false` — return every row; the response is no longer split into pages. ```bash curl "$MBA_API_BASE_URL/customers?page=2&limit=50" \ -H "x-mba-api-key: $MBA_API_KEY" # every row in one request (server pagination off) curl "$MBA_API_BASE_URL/customers?paginate=false" \ -H "x-mba-api-key: $MBA_API_KEY" ``` In `mba-cli`, `--page` / `--limit` map to the query params and `--all` sets `paginate=false`. ### Filtering List endpoints expose endpoint-specific filters (team, date range, status, search text, …). The exact parameters for each endpoint are documented in the API reference. ## Errors > Every failure returns the same envelope — a success:false flag, a human-readable message, and an errors array. ### Error envelope ```json { "success": false, "message": "API key does not have the required scope: ReadCustomer", "errors": ["API key does not have the required scope: ReadCustomer"] } ``` ### Status codes | Status | Meaning | When | | --- | --- | --- | | `400` | Bad Request | A parameter or body is invalid. The message names the field. | | `401` | Unauthorized | Missing, malformed, expired, or inactive API key. | | `403` | Forbidden | The key lacks the required scope, is outside its IP allowlist, or named another tenant. | | `404` | Not Found | No such resource in the key’s tenant. | | `409` | Conflict | The request conflicts with current state (e.g. a duplicate, or a booking slot taken). | | `422` | Unprocessable Entity | The request was understood but failed a business rule. | | `429` | Too Many Requests | Rate limited — see Rate limits. | | `500` | Internal Server Error | Unexpected server error. Retry with backoff; contact support if it persists. | ### Handling Retry `429` and `5xx` with exponential backoff. Treat `401` as a configuration problem (a bad or revoked key) rather than retrying. Read the missing scope from a `403` and grant exactly that. ## Rate limits > Requests are rate limited per API key. When a limit is exceeded the API returns 429; back off and retry. ### Limits - Each API key carries its own per-second limit (set when the key is created or edited in Settings → API keys). There is no shared per-tenant limit. - The gateway also applies a product subscription (the `Ocp-Apim-Subscription-Key`). ### Handling 429 Retry with exponential backoff and jitter. If a single key is consistently throttled, raise its limit or spread load across keys. ## Versioning > The API is versioned by release. The version currently served is always shown in the API reference. ### Scheme - Releases use semantic versioning (`MAJOR.MINOR.PATCH`). The read-only surface changes on `MINOR` and `PATCH`; `MAJOR` signals breaking changes. - The reference reflects the deployed version — you do not pin a version in the URL. ### Breaking changes Breaking changes are recorded in the changelog and, where practical, introduced behind a new field or endpoint before the old one is removed. Read the changelog before upgrading a client. ## Glossary > The terms used across these docs, defined the way we use them. ### Terms | Term | Definition | | --- | --- | | API key | A tenant-scoped credential (`mba_…`) created in Settings → API keys. Identifies the tenant and carries its scopes. | | Tenant | A business account. Each has its own data; a key can only read its own tenant. | | Application | A product a tenant runs (an id + type, e.g. `ppaws` + `mypetparlorapp`). | | Scope | A named permission a key must hold to perform a read (e.g. `ReadCustomer`). | | Subscription key | The API Management gateway key sent as `Ocp-Apim-Subscription-Key`. Not secret. | | Envelope | The JSON wrapper every response uses: `{ success, message, data }`. | | Operation | One HTTP method + path in the API; each has a unique `operationId`. | | Stamp | A regional deployment that hosts tenants. A tenant lives on exactly one stamp. | | Paginate | Whether a list is split into pages. `paginate=false` (CLI `--all`) returns every row. | ## Changelog > Release notes for the API are generated from the source repository on every release. ### Release notes - [mba-api CHANGELOG](https://github.com/mybusiness-app/web-apps/blob/main/apps/mba-api/CHANGELOG.md) — the generated release notes for the backend API. - [GitHub releases](https://github.com/mybusiness-app/web-apps/releases) — tagged releases across the platform. # API reference ## Addresses List and retrieve the addresses recorded for a tenant. ### GET /addresses List addresses Returns the addresses in the tenant identified by the API key. Paginated: use `page`/`limit`, or `paginate=false` to return every row in one page. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve an address by id`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for pagination - `limit` (query), optional — Number of addresses per page - `paginate` (query), optional — Enable or disable pagination - `customerId` (query), optional — Filter addresses by specific customer ID Reference: https://mybusinessapp.co.za/developers/api/address#tag/Address/get_all_addresses ### GET /addresses/{id} Retrieve an address by id Returns the address with the given `id` from the tenant identified by the API key. Returns 404 if the id does not exist in this tenant. Related: `List addresses`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — Address's unique identifier Reference: https://mybusinessapp.co.za/developers/api/address#tag/Address/get_single_address ## Application stamps Inspect the application stamps (deployment configuration) available to an API key. ### GET /application-stamps List application stamps Returns the application stamps (per-deployment configuration and properties) available to the caller. Paginated: use `page`/`limit` or `paginate=false`. Related: `Retrieve an application stamp by id and type`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID Reference: https://mybusinessapp.co.za/developers/api/application-stamp#tag/ApplicationStamp/getAllApplicationStamps ### GET /application-stamps/{idAndType} Retrieve an application stamp by id and type Returns the application stamp identified by `idAndType` (the application id and type joined, e.g. `ppaws-mypetparlorapp`). Related: `List application stamps`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `idAndType` (path), required — ID and type of the application stamp resource Reference: https://mybusinessapp.co.za/developers/api/application-stamp#tag/ApplicationStamp/getSingleApplicationStamp ## Applications List the applications provisioned for a tenant. ### GET /applications List applications Returns the applications provisioned for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`. Related: `Retrieve an application by id and type`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID Reference: https://mybusinessapp.co.za/developers/api/application#tag/Application/getAllApplications ### GET /applications/{idAndType} Retrieve an application by id and type Returns the application identified by `idAndType` (application id and type joined). Related: `List applications`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `idAndType` (path), required — ID of the application resource Reference: https://mybusinessapp.co.za/developers/api/application#tag/Application/getSingleApplication ## Billing accounts Billing accounts, invoices, subscriptions and transactions for a tenant. ### GET /billing/accounts List billing accounts Returns the billing accounts for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; supports sorting and filtering. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a billing account`, `List invoices`, `List subscriptions`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for paginated results - `limit` (query), optional — Number of accounts per page - `paginate` (query), optional — Whether to paginate results; false returns all matched rows - `sort` (query), optional — Field name to sort by - `order` (query), optional — Sort direction - `search` (query), optional — Search text for account records - `ids` (query), optional — Comma-separated billing account IDs to include - `userId` (query), optional — Filter by the account user ID - `state` (query), optional — Filter by account state - `subscriptionStatus` (query), optional — Filter by subscription status - `fromDate` (query), optional — UTC date string lower bound for created-at filtering - `toDate` (query), optional — UTC date string upper bound for created-at filtering Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllAccounts ### GET /billing/accounts/{id} Retrieve a billing account by id Returns the billing account with the given `id` for the tenant identified by the API key. Returns 404 if not found in this tenant. Related: `List billing accounts`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the account resource Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleAccount ### GET /billing/accounts/{id}/invoices List invoices for a billing account Returns the invoices for one billing account (`id` in the path), scoped to the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`. Related: `Retrieve a billing account`, `List invoices`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the billing account - `page` (query), optional — Page number for paginated results - `limit` (query), optional — Number of invoices per page - `paginate` (query), optional — Whether to paginate results; false returns all matched rows - `sort` (query), optional — Field name to sort by - `order` (query), optional — Sort direction - `search` (query), optional — Search text for invoice records - `type` (query), optional — Filter by invoice type - `state` (query), optional — Filter by invoice state - `collectionMethod` (query), optional — Filter by collection method - `currency` (query), optional — Filter by invoice currency code - `origin` (query), optional — Filter by invoice origin - `hasSubscription` (query), optional — Filter to invoices linked to a subscription (true) or not (false) - `ids` (query), optional — Comma-separated invoice IDs to include - `bookingIds` (query), optional — Comma-separated booking IDs to include - `subscriptionIds` (query), optional — Comma-separated subscription IDs to include - `fromDate` (query), optional — UTC date string lower bound for created-at filtering - `toDate` (query), optional — UTC date string upper bound for created-at filtering Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllAccountInvoices ### GET /billing/invoices List invoices Returns the invoices across the tenant's billing accounts. Paginated: use `page`/`limit` or `paginate=false`. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve an invoice by id`, `Retrieve an invoice by number`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for paginated results - `limit` (query), optional — Number of invoices per page - `paginate` (query), optional — Whether to paginate results; false returns all matched rows - `sort` (query), optional — Field name to sort by - `order` (query), optional — Sort direction - `search` (query), optional — Search text for invoice records - `ids` (query), optional — Comma-separated invoice IDs to include - `bookingIds` (query), optional — Comma-separated booking IDs to include - `subscriptionIds` (query), optional — Comma-separated subscription IDs to include - `type` (query), optional — Filter by invoice type - `state` (query), optional — Filter by invoice state - `collectionMethod` (query), optional — Filter by collection method - `currency` (query), optional — Filter by invoice currency code - `origin` (query), optional — Filter by invoice origin - `hasSubscription` (query), optional — Filter to invoices linked to a subscription (true) or not (false) - `fromDate` (query), optional — UTC date string lower bound for created-at filtering - `toDate` (query), optional — UTC date string upper bound for created-at filtering Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllInvoices ### GET /billing/invoices/number/{invoiceNumber} Retrieve an invoice by number Returns the invoice with the given `invoiceNumber`. Invoice numbers are unique per tenant. Related: `Retrieve an invoice by id`, `List invoices`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `invoiceNumber` (path), required — Number of the account invoice resource Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleAccountInvoiceByNumber ### GET /billing/invoices/{invoiceId} Retrieve an invoice by id Returns the invoice with the given `invoiceId` for the tenant identified by the API key. Related: `List invoices`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `invoiceId` (path), required — ID of the invoice resource Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleInvoice ### GET /billing/subscriptions List subscriptions Returns the subscriptions across the tenant's billing accounts. Paginated: use `page`/`limit` or `paginate=false`; supports sorting and state/plan filters. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a subscription`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for paginated results - `limit` (query), optional — Number of subscriptions per page - `paginate` (query), optional — Whether to paginate results; false returns all matched rows - `sort` (query), optional — Field name to sort by - `order` (query), optional — Sort direction - `search` (query), optional — Free-text search across subscription records - `ids` (query), optional — Comma-separated subscription IDs to include - `state` (query), optional — Filter by subscription state - `planId` (query), optional — Filter by billing plan ID - `fromDate` (query), optional — UTC date string lower bound for created-at filtering - `toDate` (query), optional — UTC date string upper bound for created-at filtering Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllSubscriptions ### GET /billing/subscriptions/{subscriptionId} Retrieve a subscription by id Returns the subscription with the given `subscriptionId` for the tenant identified by the API key. Related: `List subscriptions`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `subscriptionId` (path), required — ID of the subscription resource Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleSubscription ### GET /billing/transactions List transactions Returns the billing transactions across the tenant's accounts. Paginated: use `page`/`limit` or `paginate=false`; supports status and date filters. To count without fetching rows, request `limit=1` and read `metadata.total`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for paginated results - `limit` (query), optional — Number of transactions per page - `paginate` (query), optional — Whether to paginate results; false returns all matched rows - `sort` (query), optional — Field name to sort by - `order` (query), optional — Sort direction - `ids` (query), optional — Comma-separated account transaction IDs to include - `status` (query), optional — Filter by transaction status - `fromDate` (query), optional — UTC date string lower bound for created-at filtering - `toDate` (query), optional — UTC date string upper bound for created-at filtering Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllTransactions ## Bookings List, search and retrieve the bookings recorded for a tenant. ### GET /bookings List bookings Returns the bookings for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by customer, employee, state, date range, and team. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Search bookings`, `Retrieve a booking by id`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number - `limit` (query), optional — Items per page - `paginate` (query), optional — Enable pagination - `customerId` (query), optional — Filter by customer ID - `employeeRole` (query), optional — Filter by employee role - `transportMode` (query), optional — Filter by transport mode - `bookingState` (query), optional — Filter by booking state - `sortKey` (query), optional — Sort key - `sortValue` (query), optional — Sort value - `fromDate` (query), optional — Filter from date - `toDate` (query), optional — Filter to date - `approved` (query), optional — Filter by approval status - `paid` (query), optional — Filter by payment status - `teamId` (query), optional — Filter by team ID - `teamIds` (query), optional — Filter by multiple team IDs (comma separated) Reference: https://mybusinessapp.co.za/developers/api/booking#tag/Booking/get_all_bookings ### GET /bookings/search Search bookings Text-searches the tenant's bookings by `query`. Paginated: use `page`/`limit` or `paginate=false`; also supports customer, employee, state, date-range, and team filters. Related: `List bookings`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number - `limit` (query), optional — Items per page - `paginate` (query), optional — Enable pagination - `customerId` (query), optional — Filter by customer ID - `employeeRole` (query), optional — Filter by employee role - `transportMode` (query), optional — Filter by transport mode - `bookingState` (query), optional — Filter by booking state - `sortKey` (query), optional — Sort key - `sortValue` (query), optional — Sort value - `fromDate` (query), optional — Filter from date - `toDate` (query), optional — Filter to date - `approved` (query), optional — Filter by approval status - `paid` (query), optional — Filter by payment status - `query` (query), required — Search query text - `teamId` (query), optional — Filter by team ID Reference: https://mybusinessapp.co.za/developers/api/booking#tag/Booking/search_all_bookings ### GET /bookings/{id} Retrieve a booking by id Returns the booking with the given `id` for the tenant identified by the API key, with its associated data. Related: `List bookings`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the booking resource Reference: https://mybusinessapp.co.za/developers/api/booking#tag/Booking/get_single_booking ## Breeds Browse the breed catalogue by id, unique name or size. ### GET /breeds List breeds Returns the breed catalogue available to the tenant. Paginated: use `page`/`limit` or `paginate=false`. Related: `Retrieve a breed by unique name`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID Reference: https://mybusinessapp.co.za/developers/api/breed#tag/Breed/getAllBreeds ### GET /breeds/uniquename/{uniqueName} Retrieve a breed by unique name Returns the breed with the given `uniqueName` (a stable slug, unlike the id). Related: `List breeds`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `uniqueName` (path), required — Unique name of the breed resource Reference: https://mybusinessapp.co.za/developers/api/breed#tag/Breed/getSingleBreedByUniqueName ### GET /breeds/{id} Retrieve a breed by id Returns the breed with the given `id`. Related: `List breeds`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the breed resource Reference: https://mybusinessapp.co.za/developers/api/breed#tag/Breed/getSingleBreed ## Customers List, search and retrieve customer profiles, with team and custom-field filters. ### GET /customers List customers Returns the customers in the tenant identified by the API key. Paginated: use `page`/`limit`, or `paginate=false` to return every row in one page. Filter by team (`teamId`/`teamIds`), creation date (`fromDate`/`toDate`), activity (`hasBookings`/`hasPets`/`hasAddresses`), flags (`isDifficult`/`isLatePayer`), booking/pet counts, and custom fields (`cf_`). To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Search customers`, `Retrieve a customer by id`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for pagination - `limit` (query), optional — Number of customers per page - `paginate` (query), optional — Enable or disable pagination - `query` (query), optional — Text search query for customer matching - `teamId` (query), optional — Filter customers by specific team ID - `teamIds` (query), optional — Filter customers by multiple team IDs (comma-separated) - `fromDate` (query), optional — Start date for filtering customers by creation date - `toDate` (query), optional — End date for filtering customers by creation date - `hasBookings` (query), optional — Filter to customers with (true) or without (false) bookings - `hasPets` (query), optional — Filter to customers with (true) or without (false) pets - `hasAddresses` (query), optional — Filter to customers with (true) or without (false) addresses - `isDifficult` (query), optional — Filter by the difficult-customer flag - `isLatePayer` (query), optional — Filter by the late-payer flag - `minBookings` (query), optional — Minimum number of bookings - `maxBookings` (query), optional — Maximum number of bookings - `minPets` (query), optional — Minimum number of pets - `maxPets` (query), optional — Maximum number of pets Reference: https://mybusinessapp.co.za/developers/api/customer#tag/Customer/get_all_customers ### GET /customers/search Search customers Text-searches the tenant's customers by `query`. Paginated: use `page`/`limit` or `paginate=false`; also supports team and date-range filters. Related: `List customers`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for pagination - `limit` (query), optional — Number of customers per page - `paginate` (query), optional — Enable or disable pagination - `query` (query), required — Text search query for customer matching - `teamId` (query), optional — Filter customers by specific team ID - `teamIds` (query), optional — Filter customers by multiple team IDs (comma-separated) - `fromDate` (query), optional — Start date for filtering customers by creation date - `toDate` (query), optional — End date for filtering customers by creation date - `hasBookings` (query), optional — Filter to customers with (true) or without (false) bookings - `hasPets` (query), optional — Filter to customers with (true) or without (false) pets - `hasAddresses` (query), optional — Filter to customers with (true) or without (false) addresses - `isDifficult` (query), optional — Filter by the difficult-customer flag - `isLatePayer` (query), optional — Filter by the late-payer flag - `minBookings` (query), optional — Minimum number of bookings - `maxBookings` (query), optional — Maximum number of bookings - `minPets` (query), optional — Minimum number of pets - `maxPets` (query), optional — Maximum number of pets Reference: https://mybusinessapp.co.za/developers/api/customer#tag/Customer/search_all_customers ### GET /customers/{id} Retrieve a customer by id Returns the customer with the given `id` for the tenant identified by the API key, with profile metadata and team relationships. Related: `List customers`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — Customer's unique identifier Reference: https://mybusinessapp.co.za/developers/api/customer#tag/Customer/get_single_customer ## Documents List documents and retrieve them by id or by reference. ### GET /documents List documents Returns the documents for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by document type. Related: `Retrieve a document by reference`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number - `limit` (query), optional — Items per page - `paginate` (query), optional — Enable pagination - `documentType` (query), optional — Filter by document type - `referenceType` (query), optional — Filter by reference type Reference: https://mybusinessapp.co.za/developers/api/document#tag/Document/get_all_docs ### GET /documents/reference/{referenceType}/{referenceId} Retrieve a document by reference Returns the document linked to a `referenceType` + `referenceId` pair (e.g. an invoice or booking). Related: `List documents`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `referenceType` (path), required — Reference type of the document resource - `referenceId` (path), required — Reference ID of the document resource - `documentType` (query), optional — Document type to filter by Reference: https://mybusinessapp.co.za/developers/api/document#tag/Document/get_single_document_by_reference ### GET /documents/{id} Retrieve a document by id Returns the document with the given `id`. Related: `List documents`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the document resource Reference: https://mybusinessapp.co.za/developers/api/document#tag/Document/get_single_doc ## Employees List and retrieve employees, including by Firebase UID. ### GET /employees List employees Returns the employees for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by team. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve an employee by id`, `Retrieve an employee by Firebase UID`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for pagination - `limit` (query), optional — Number of employees per page - `paginate` (query), optional — Enable or disable pagination - `teamId` (query), optional — Filter employees by specific team ID - `teamIds` (query), optional — Filter employees by multiple team IDs (comma-separated) Reference: https://mybusinessapp.co.za/developers/api/employee#tag/Employee/get_all_employees ### GET /employees/uid/{uid} Retrieve an employee by Firebase UID Returns the employee with the given Firebase `uid` (useful when you only have the signed-in user's id). Related: `Retrieve an employee by id`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `uid` (path), required — Employee's unique identifier (UID) Reference: https://mybusinessapp.co.za/developers/api/employee#tag/Employee/get_single_employee_by_uid ### GET /employees/{id} Retrieve an employee by id Returns the employee with the given `id`, including role assignments and team associations. Related: `List employees`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — Employee's unique identifier Reference: https://mybusinessapp.co.za/developers/api/employee#tag/Employee/get_single_employee ## API keys List API key metadata and read daily or monthly usage. Secret values are never returned. ### GET /management/api-keys List API keys Returns the API keys for the tenant identified by the API key. Secret values are never returned, only metadata (name, prefix, scopes, usage). Related: `Retrieve an API key`, `Retrieve API key usage`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID Reference: https://mybusinessapp.co.za/developers/api/api-key#tag/APIKey/getAllAPIKeys ### GET /management/api-keys/usage Retrieve tenant API key usage Returns monthly usage statistics for all API keys in the tenant. Related: `Retrieve API key usage`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `months` (query), optional — Number of months to retrieve usage for (default: 12) Reference: https://mybusinessapp.co.za/developers/api/api-key#tag/APIKey/getTenantAPIKeyUsage ### GET /management/api-keys/{id} Retrieve an API key by id Returns the metadata for a single API key by `id` (never the secret). Related: `List API keys`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the API key Reference: https://mybusinessapp.co.za/developers/api/api-key#tag/APIKey/getSingleAPIKey ### GET /management/api-keys/{id}/usage Retrieve API key usage Returns daily usage statistics for a single API key by `id`. Related: `Retrieve tenant API key usage`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the API key - `days` (query), optional — Number of days to retrieve usage for (default: 30) Reference: https://mybusinessapp.co.za/developers/api/api-key#tag/APIKey/getSingleAPIKeyUsage ## Pets List and retrieve the pets recorded for a tenant. ### GET /pets List pets Returns the pets for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by customer and team. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a pet by id`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for pagination - `limit` (query), optional — Number of pets per page - `paginate` (query), optional — Enable or disable pagination - `customerId` (query), optional — Filter pets by specific customer ID Reference: https://mybusinessapp.co.za/developers/api/pet#tag/Pet/get_all_pets ### GET /pets/{id} Retrieve a pet by id Returns the pet with the given `id`, including profile data. Related: `List pets`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — Pet's unique identifier Reference: https://mybusinessapp.co.za/developers/api/pet#tag/Pet/get_single_pet ## Services List and retrieve the services a tenant offers. ### GET /services List services Returns the services offered by the tenant. Paginated: use `page`/`limit` or `paginate=false`; filter by team, type, and archived/deleted state. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a service by id`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID Reference: https://mybusinessapp.co.za/developers/api/service#tag/Service/getAllServices ### GET /services/{id} Retrieve a service by id Returns the service with the given `id` for the tenant identified by the API key. Related: `List services`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the service resource Reference: https://mybusinessapp.co.za/developers/api/service#tag/Service/getSingleService ## Stamps List and retrieve stamps and their deployment configuration. ### GET /stamps List stamps Returns the stamps (application stamps with deployment configuration) available to the caller. Paginated: use `page`/`limit` or `paginate=false`. Related: `Retrieve a stamp by id`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID Reference: https://mybusinessapp.co.za/developers/api/stamp#tag/Stamp/getAllStamps ### GET /stamps/{id} Retrieve a stamp by id Returns the stamp with the given `id`. Related: `List stamps`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the stamp resource Reference: https://mybusinessapp.co.za/developers/api/stamp#tag/Stamp/getSingleStamp ## Teams List and retrieve a tenant's teams. ### GET /teams List teams Returns the teams in the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a team by id`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for pagination - `limit` (query), optional — Number of items per page - `paginate` (query), optional — Enable or disable pagination - `teamType` (query), optional — Filter teams by team type Reference: https://mybusinessapp.co.za/developers/api/team#tag/Team/get_all_teams ### GET /teams/{id} Retrieve a team by id Returns the team with the given `id`. Related: `List teams`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the team resource Reference: https://mybusinessapp.co.za/developers/api/team#tag/Team/get_single_team ## Tenants List tenants and retrieve one by record id or tenant id. ### GET /tenants List tenants Returns the tenants visible to the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by name and status. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a tenant by id`, `Retrieve a tenant by tenant id`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — The page number to retrieve - `limit` (query), optional — The number of items to retrieve per page - `paginate` (query), optional — Used to determine if pagination is applied to the results. If true, the results will be paginated. If false, the results will not be paginated and all results will be returned. Reference: https://mybusinessapp.co.za/developers/api/tenant#tag/Tenant/get_all_tenants ### GET /tenants/tenant/{tenantID} Retrieve a tenant by tenant id Returns the tenant with the given `tenantID` (the tenant's own identifier, distinct from the record id). Related: `List tenants`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `tenantID` (path), required — Unique name of the tenant resource Reference: https://mybusinessapp.co.za/developers/api/tenant#tag/Tenant/get_single_tenant_by_tenant_id ### GET /tenants/{id} Retrieve a tenant by id Returns the tenant with the given `id` and its configuration. Related: `List tenants`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the tenant resource Reference: https://mybusinessapp.co.za/developers/api/tenant#tag/Tenant/get_single_tenant ## Transports List and retrieve the transport modes a tenant offers. ### GET /transports List transports Returns the transport modes offered by the tenant. Paginated: use `page`/`limit` or `paginate=false`; filter by team. Related: `Retrieve a transport by mode`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `page` (query), optional — Page number for pagination - `limit` (query), optional — Number of transports per page - `paginate` (query), optional — Whether to paginate results; false returns all matched rows - `teamId` (query), optional — Filter transports by team ID - `includeParent` (query), optional — Include transports belonging to parent teams Reference: https://mybusinessapp.co.za/developers/api/transport#tag/Transport/getAllTransports ### GET /transports/transportmode/{transportMode} Retrieve a transport by mode Returns the transport for the given `transportMode`. Related: `List transports`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `transportMode` (path), required — Unique name of the transport resource - `teamId` (query), optional — Filter transports by team ID - `includeParent` (query), optional — Include transports belonging to parent teams Reference: https://mybusinessapp.co.za/developers/api/transport#tag/Transport/getSingleTransportByTransportMode ### GET /transports/{id} Retrieve a transport by id Returns the transport with the given `id`. Related: `List transports`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the transport resource Reference: https://mybusinessapp.co.za/developers/api/transport#tag/Transport/getSingleTransport ## Vouchers List and retrieve vouchers, including by voucher code. ### GET /vouchers List vouchers Returns the vouchers for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by team. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a voucher by code`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID Reference: https://mybusinessapp.co.za/developers/api/voucher#tag/Voucher/getAllVouchers ### GET /vouchers/vouchercode/{voucherCode} Retrieve a voucher by code Returns the voucher with the given `voucherCode`. Related: `List vouchers`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `voucherCode` (path), required — The unique code of the voucher resource Reference: https://mybusinessapp.co.za/developers/api/voucher#tag/Voucher/getSingleVoucherByVoucherCode ### GET /vouchers/{id} Retrieve a voucher by id Returns the voucher with the given `id`. Related: `List vouchers`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the voucher resource Reference: https://mybusinessapp.co.za/developers/api/voucher#tag/Voucher/getSingleVoucher ## Weight classes List and retrieve weight classes by id, size or weight. ### GET /weightclasses List weight classes Returns the weight classes for the tenant. Paginated: use `page`/`limit` or `paginate=false`. Related: `Retrieve a weight class by id`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID Reference: https://mybusinessapp.co.za/developers/api/weight-class#tag/WeightClass/getAllWeightClasses ### GET /weightclasses/size/{size} Retrieve a weight class by size Returns the weight class for the given `size`. Related: `Retrieve a weight class by weight`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `size` (path), required — Size of the weight class resource Reference: https://mybusinessapp.co.za/developers/api/weight-class#tag/WeightClass/getSingleWeightClassBySize ### GET /weightclasses/weight/{weight} Retrieve a weight class by weight Returns the weight class for the given `weight`. Related: `Retrieve a weight class by size`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `weight` (path), required — Weight of the weight class resource Reference: https://mybusinessapp.co.za/developers/api/weight-class#tag/WeightClass/getSingleWeightClassByWeight ### GET /weightclasses/{id} Retrieve a weight class by id Returns the weight class with the given `id`. Related: `List weight classes`. Parameters: - `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb) - `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant - `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID - `id` (path), required — ID of the weight class resource Reference: https://mybusinessapp.co.za/developers/api/weight-class#tag/WeightClass/getSingleWeightClass # CLI reference mba-cli version: `0.3.2` ## Global options - `--api-key` (string): API key (default $MBA_API_KEY, then keychain) - `--application-id` (string): Application ID to scope reads to, set together with --application-type (default: the API key's tenant; Studio keys only) - `--application-type` (string): Application type to scope reads to, e.g. mypetparlorapp, set together with --application-id (default: the API key's application type) - `--base-url` (string): API base URL (default $MBA_API_BASE_URL or the production gateway) - `--subscription-key` (string): APIM subscription key (default $MBA_APIM_SUBSCRIPTION_KEY, then a compiled-in default) ## account Read billing accounts ### mba-cli account get Get one billing account by id Get single account resource Get a single account resource Get one billing account by id Flags: - `--id` (string): Billing account id ### mba-cli account ls List billing accounts List billing accounts Retrieves billing accounts with optional pagination, sorting, text search, account/user filters, state filters, subscription-status filters, and created-date range filters. For OpenAPI tool calls, pass these filters in query. List billing accounts Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--from-date` (string): Query parameter fromDate (from the API spec) - `--ids` (string): Query parameter ids (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--order` (string): Query parameter order (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--search` (string): Query parameter search (from the API spec) - `--sort` (string): Query parameter sort (from the API spec) - `--state` (string): Query parameter state (from the API spec) - `--subscription-status` (string): Query parameter subscriptionStatus (from the API spec) - `--to-date` (string): Query parameter toDate (from the API spec) - `--user-id` (string): Query parameter userId (from the API spec) ## address Read addresses (key-scoped) ### mba-cli address get Get one address by id Retrieve address by ID Fetches detailed address information using its unique identifier. Returns complete address data including associated metadata. Get one address by id Flags: - `--id` (string): Address record id ### mba-cli address ls List addresses List all addresses with pagination and filtering Retrieves a paginated list of addresses with optional customer-based filtering. Supports customizable page size and customer-specific views. Returns address records with their associated metadata. List addresses Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--customer-id` (string): Query parameter customerId (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) ## application Read applications ### mba-cli application get Get one application by id-type (e.g. accustyle-mypetparlorapp) Get single application resource Get a single application resource Get one application by id-type (e.g. accustyle-mypetparlorapp) Flags: - `--id` (string): Application id-type (id + '-' + type) ### mba-cli application ls List applications Get all application resources Get all the application resources List applications Flags: - `--all` (bool, default `false`): Return all applications (paginate=false) - `--limit` (int, default `20`): Items per page - `--page` (int, default `1`): Page number ## application-stamp Read application stamps ### mba-cli application-stamp get Get one application stamp by id-type (e.g. mppdemo-mypetparlorapp) Get single application stamp resource Get a single application stamp resource Get one application stamp by id-type (e.g. mppdemo-mypetparlorapp) Flags: - `--id` (string): Stamp id-type (id + '-' + type) ### mba-cli application-stamp ls List application stamps Get all application stamp resources Get all the application stamp resources List application stamps Flags: - `--all` (bool, default `false`): Return all stamps (paginate=false) - `--limit` (int, default `20`): Items per page - `--page` (int, default `1`): Page number ## booking Read bookings (key-scoped) ### mba-cli booking get Get one booking by id Get single booking resource Retrieves a specific booking by its ID with all associated details including customer information, pet details, service information, and booking status Get one booking by id Flags: - `--id` (string): Booking record id ### mba-cli booking ls List bookings Get all booking resources Get all the booking resources with optional filtering by customer, employee, booking state, date range, and team List bookings Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--approved` (bool): Query parameter approved (from the API spec) - `--booking-state` (string): Query parameter bookingState (from the API spec) - `--customer-id` (string): Query parameter customerId (from the API spec) - `--employee-role` (string): Query parameter employeeRole (from the API spec) - `--from-date` (string): Query parameter fromDate (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--paid` (bool): Query parameter paid (from the API spec) - `--sort-key` (string): Query parameter sortKey (from the API spec) - `--sort-value` (string): Query parameter sortValue (from the API spec) - `--team-id` (string): Query parameter teamId (from the API spec) - `--team-ids` (string): Query parameter teamIds (from the API spec) - `--to-date` (string): Query parameter toDate (from the API spec) - `--transport-mode` (string): Query parameter transportMode (from the API spec) ### mba-cli booking search Text-search bookings Search all booking resources Search all the booking resources using a text query that matches against booking details, customer information, and other relevant fields Text-search bookings Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--approved` (bool): Query parameter approved (from the API spec) - `--booking-state` (string): Query parameter bookingState (from the API spec) - `--customer-id` (string): Query parameter customerId (from the API spec) - `--employee-role` (string): Query parameter employeeRole (from the API spec) - `--from-date` (string): Query parameter fromDate (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--paid` (bool): Query parameter paid (from the API spec) - `--query` (string): Query parameter query (from the API spec) - `--sort-key` (string): Query parameter sortKey (from the API spec) - `--sort-value` (string): Query parameter sortValue (from the API spec) - `--team-id` (string): Query parameter teamId (from the API spec) - `--to-date` (string): Query parameter toDate (from the API spec) - `--transport-mode` (string): Query parameter transportMode (from the API spec) ## breed Read breeds ### mba-cli breed get Get one breed by id Get single breed resource Get a single breed resource Get one breed by id Flags: - `--id` (string): Breed record id ### mba-cli breed get-by-uniquename Get one breed by unique name Get single breed resource by its unique name Get a single breed resource by its unique name Get one breed by unique name Flags: - `--name` (string): Breed unique name ### mba-cli breed ls List breeds Get all breed resources Get all the breed resources List breeds Flags: - `--all` (bool, default `false`): Return all breeds (paginate=false) - `--limit` (int, default `20`): Items per page - `--page` (int, default `1`): Page number ## connector Manage the mba-api connection (key auth) ### mba-cli connector auth Store an mba-api API key (mba_…) in the keychain Flags: - `--key` (string): API key (non-interactive; otherwise prompts) ### mba-cli connector status Non-interactive readiness check (never prompts) Flags: - `--json` (bool, default `false`): Machine-readable output ## customer Read customers (key-scoped) ### mba-cli customer get Get one customer by id Retrieve customer by ID Fetches detailed customer information using their unique identifier. Returns complete profile including team associations, Xero integration status, and custom field values. This endpoint is similar to the get_all_customers endpoint, but it only returns a single customer. Get one customer by id Flags: - `--id` (string): Customer record id ### mba-cli customer ls List customers (default: page 1, 20 per page) List all customers with pagination and filtering Retrieves a paginated list of customers with optional team-based filtering. Supports customizable page size and team-specific views. Returns customer profiles with their associated metadata and team relationships. Allows filtering by date range based on when customers were created using from date and to date parameters. Custom-field filters use the repeatable cf_= convention, where fieldId is a custom_field_definitions.id. List customers (default: page 1, 20 per page) Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--from-date` (string): Query parameter fromDate (from the API spec) - `--has-addresses` (bool): Query parameter hasAddresses (from the API spec) - `--has-bookings` (bool): Query parameter hasBookings (from the API spec) - `--has-pets` (bool): Query parameter hasPets (from the API spec) - `--is-difficult` (bool): Query parameter isDifficult (from the API spec) - `--is-late-payer` (bool): Query parameter isLatePayer (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--max-bookings` (int): Query parameter maxBookings (from the API spec) - `--max-pets` (int): Query parameter maxPets (from the API spec) - `--min-bookings` (int): Query parameter minBookings (from the API spec) - `--min-pets` (int): Query parameter minPets (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--query` (string): Query parameter query (from the API spec) - `--team-id` (string): Query parameter teamId (from the API spec) - `--team-ids` (string): Query parameter teamIds (from the API spec) - `--to-date` (string): Query parameter toDate (from the API spec) ### mba-cli customer search Text-search customers Search customers with text matching, pagination and filtering Performs semantic text search across customer records with pagination and team filtering. Matches against names, emails, phone numbers, user ID, customer EFT reference and other relevant fields. Supports advanced filtering and sorting options, including filtering by when customers were created using a date range. This endpoint is similar to the get_all_customers endpoint, but it only returns a list of customers that match the search query. Custom-field filters use the repeatable cf_= convention, where fieldId is a custom_field_definitions.id. Text-search customers Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--from-date` (string): Query parameter fromDate (from the API spec) - `--has-addresses` (bool): Query parameter hasAddresses (from the API spec) - `--has-bookings` (bool): Query parameter hasBookings (from the API spec) - `--has-pets` (bool): Query parameter hasPets (from the API spec) - `--is-difficult` (bool): Query parameter isDifficult (from the API spec) - `--is-late-payer` (bool): Query parameter isLatePayer (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--max-bookings` (int): Query parameter maxBookings (from the API spec) - `--max-pets` (int): Query parameter maxPets (from the API spec) - `--min-bookings` (int): Query parameter minBookings (from the API spec) - `--min-pets` (int): Query parameter minPets (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--query` (string): Query parameter query (from the API spec) - `--team-id` (string): Query parameter teamId (from the API spec) - `--team-ids` (string): Query parameter teamIds (from the API spec) - `--to-date` (string): Query parameter toDate (from the API spec) ## document Read documents (key-scoped) ### mba-cli document get Get one document by id Get single document resource Get a single document resource by its unique identifier Get one document by id Flags: - `--id` (string): Document record id ### mba-cli document get-by-reference Get one document by reference type and id Get single document resource by reference Get a single document resource by its reference type and reference ID, with optional document type filtering Get one document by reference type and id Flags: - `--ref-id` (string): Reference id - `--type` (string): Reference type ### mba-cli document ls List documents Get all document resources Get all the document resources with optional filtering by document type and reference type List documents Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--document-type` (string): Query parameter documentType (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--reference-type` (string): Query parameter referenceType (from the API spec) ## employee Read employees (key-scoped) ### mba-cli employee get Get one employee by id Retrieve employee by ID Fetches detailed employee information using their unique identifier. Returns complete profile including role assignments, team associations, and profile metadata. Get one employee by id Flags: - `--id` (string): Employee record id ### mba-cli employee get-by-uid Get one employee by auth uid Retrieve employee by UID Fetches employee profile using their unique identifier (UID). Alternative lookup method that uses UID instead of internal ID. Returns complete employee data including roles and associations. Get one employee by auth uid Flags: - `--uid` (string): Employee auth uid ### mba-cli employee ls List employees List all employees with pagination and filtering Retrieves a paginated list of employees with optional team-based filtering. Supports customizable page size and team-specific views. Returns employee profiles with their associated metadata, roles, and team relationships. List employees Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--team-id` (string): Query parameter teamId (from the API spec) - `--team-ids` (string): Query parameter teamIds (from the API spec) ## invoice Read invoices ### mba-cli invoice account-invoices List invoices for one billing account List invoices for a billing account Retrieves invoices for one billing account with pagination, sorting, search, invoice type/state, collection method, currency, origin, related booking/subscription IDs, invoice ID CSV filters, and created-date ranges. For OpenAPI tool calls, pass the account id in path and all list controls in query. List invoices for one billing account Flags: - `--account-id` (string): Billing account id - `--all` (bool, default `false`): Return all rows (paginate=false) - `--booking-ids` (string): Query parameter bookingIds (from the API spec) - `--collection-method` (string): Query parameter collectionMethod (from the API spec) - `--currency` (string): Query parameter currency (from the API spec) - `--from-date` (string): Query parameter fromDate (from the API spec) - `--has-subscription` (bool): Query parameter hasSubscription (from the API spec) - `--ids` (string): Query parameter ids (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--order` (string): Query parameter order (from the API spec) - `--origin` (string): Query parameter origin (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--search` (string): Query parameter search (from the API spec) - `--sort` (string): Query parameter sort (from the API spec) - `--state` (string): Query parameter state (from the API spec) - `--subscription-ids` (string): Query parameter subscriptionIds (from the API spec) - `--to-date` (string): Query parameter toDate (from the API spec) - `--type` (string): Query parameter type (from the API spec) ### mba-cli invoice get Get one invoice by id Get single invoice resource Get a single invoice resource Get one invoice by id Flags: - `--id` (string): Invoice id ### mba-cli invoice get-by-number Get one invoice by invoice number Get single account invoice by number resource Get a single account invoice by number resource Get one invoice by invoice number Flags: - `--number` (string): Invoice number with prefix (e.g. INVCS-1843) ### mba-cli invoice ls List invoices across billing accounts List invoices across billing accounts Retrieves invoices across billing accounts with pagination, sorting, search, invoice type/state, collection method, currency, origin, related booking/subscription IDs, invoice ID CSV filters, and created-date ranges. Studio Copilot should pass these controls in mpptenant_call_api.query when paging or narrowing invoice results. List invoices across billing accounts Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--booking-ids` (string): Query parameter bookingIds (from the API spec) - `--collection-method` (string): Query parameter collectionMethod (from the API spec) - `--currency` (string): Query parameter currency (from the API spec) - `--from-date` (string): Query parameter fromDate (from the API spec) - `--has-subscription` (bool): Query parameter hasSubscription (from the API spec) - `--ids` (string): Query parameter ids (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--order` (string): Query parameter order (from the API spec) - `--origin` (string): Query parameter origin (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--search` (string): Query parameter search (from the API spec) - `--sort` (string): Query parameter sort (from the API spec) - `--state` (string): Query parameter state (from the API spec) - `--subscription-ids` (string): Query parameter subscriptionIds (from the API spec) - `--to-date` (string): Query parameter toDate (from the API spec) - `--type` (string): Query parameter type (from the API spec) ## key Read API keys (key-scoped) ### mba-cli key get Get one API key by id Get single API key Get a single API key by ID Get one API key by id Flags: - `--id` (string): API key record id ### mba-cli key ls List API keys Get all API keys Get all the API keys for the current tenant List API keys Flags: - `--all` (bool, default `false`): Return all keys (paginate=false) - `--limit` (int, default `20`): Items per page - `--page` (int, default `1`): Page number ### mba-cli key usage Show API key usage (tenant-wide, or one key with --id) Get tenant API key usage Get the monthly usage statistics for all API keys across the tenant --- Get single API key usage Get the daily usage statistics for a single API key Show API key usage (tenant-wide, or one key with --id) Flags: - `--days` (int, default `0`): Key usage window in days - `--id` (string): API key record id (omit for tenant usage) - `--months` (int, default `0`): Tenant usage window in months ## pet Read pets (key-scoped) ### mba-cli pet get Get one pet by id Retrieve pet by ID Fetches detailed pet information using its unique identifier. Returns complete pet data including associated metadata. Get one pet by id Flags: - `--id` (string): Pet record id ### mba-cli pet ls List pets List all pets with pagination and filtering Retrieves a paginated list of pets with optional customer-based filtering. Supports customizable page size and customer-specific views. Returns pet records with their associated metadata. List pets Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--customer-id` (string): Query parameter customerId (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) ## service Read services (key-scoped) ### mba-cli service get Get one service by id Get single service resource Get a single service resource Get one service by id Flags: - `--id` (string): Service record id ### mba-cli service ls List services Get all service resources Get all the service resources List services Flags: - `--all` (bool, default `false`): Return all services (paginate=false) - `--limit` (int, default `20`): Items per page - `--page` (int, default `1`): Page number ## stamp Read stamps (Studio stamps pages) ### mba-cli stamp get Get one stamp by id Get single stamp resource Get a single stamp resource Get one stamp by id Flags: - `--id` (string): Stamp record id ### mba-cli stamp ls List stamps Get all stamp resources Get all the stamp resources List stamps Flags: - `--all` (bool, default `false`): Return all stamps (paginate=false) - `--limit` (int, default `20`): Items per page - `--page` (int, default `1`): Page number ## subscription Read subscriptions ### mba-cli subscription get Get one subscription by id Get single subscription resource Get a single subscription resource Get one subscription by id Flags: - `--id` (string): Subscription id ### mba-cli subscription ls List subscriptions List subscriptions across billing accounts Retrieves subscriptions across billing accounts with optional pagination, sorting, search, subscription ID CSV filters, state, plan ID, and created-date ranges. Studio Copilot should pass page, filters, and sort controls in mpptenant_call_api.query. List subscriptions Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--from-date` (string): Query parameter fromDate (from the API spec) - `--ids` (string): Query parameter ids (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--order` (string): Query parameter order (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--plan-id` (string): Query parameter planId (from the API spec) - `--search` (string): Query parameter search (from the API spec) - `--sort` (string): Query parameter sort (from the API spec) - `--state` (string): Query parameter state (from the API spec) - `--to-date` (string): Query parameter toDate (from the API spec) ## team Read teams (key-scoped) ### mba-cli team get Get one team by id Get single team resource Get a single team resource by its unique identifier. Returns detailed information about the team including its configuration. Get one team by id Flags: - `--id` (string): Team record id ### mba-cli team ls List teams Get all team resources Get all the team resources for the organization. Returns a paginated list of teams that can be filtered by various parameters. List teams Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--team-type` (string): Query parameter teamType (from the API spec) ## tenant Read tenants (key-scoped) ### mba-cli tenant get Get one tenant by id or tenant ID Get single tenant resource Get a single tenant resource by its unique identifier with all configuration details --- Get single tenant resource by its unique name Get a single tenant resource by its unique tenant identifier with all configuration details Get one tenant by id or tenant ID Flags: - `--id` (string): Tenant record id - `--tenant-id` (string): Tenant slug (e.g. waggytails) ### mba-cli tenant ls List tenants (default: page 1, 20 per page) Get all tenant resources Get all the tenant resources with optional pagination and filtering List tenants (default: page 1, 20 per page) Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) ## transaction Read billing transactions ### mba-cli transaction ls List billing transactions List transactions across billing accounts Retrieves billing transactions across accounts with optional pagination, sorting, transaction ID CSV filters, status filtering, and created-date ranges. Studio Copilot should pass page, filters, and sort controls in mpptenant_call_api.query. List billing transactions Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--from-date` (string): Query parameter fromDate (from the API spec) - `--ids` (string): Query parameter ids (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--order` (string): Query parameter order (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--sort` (string): Query parameter sort (from the API spec) - `--status` (string): Query parameter status (from the API spec) - `--to-date` (string): Query parameter toDate (from the API spec) ## transport Read transports ### mba-cli transport get Get one transport by id Get single transport resource Get a single transport resource Get one transport by id Flags: - `--id` (string): Transport record id ### mba-cli transport get-by-mode Get one transport by transport mode Get single transport resource by its unique name Get a single transport resource by its unique name Get one transport by transport mode Flags: - `--include-parent` (bool): Query parameter includeParent (from the API spec) - `--mode` (string): Transport mode - `--team-id` (string): Query parameter teamId (from the API spec) ### mba-cli transport ls List transports Get all transport resources Get all the transport resources List transports Flags: - `--all` (bool, default `false`): Return all rows (paginate=false) - `--include-parent` (bool): Query parameter includeParent (from the API spec) - `--limit` (int, default `20`): Query parameter limit (from the API spec) - `--page` (int, default `1`): Query parameter page (from the API spec) - `--paginate` (bool, default `true`): Query parameter paginate (from the API spec) - `--team-id` (string): Query parameter teamId (from the API spec) ## version Print mba-cli version ## voucher Read vouchers (key-scoped) ### mba-cli voucher get Get one voucher by id Get single voucher resource Get a single voucher resource Get one voucher by id Flags: - `--id` (string): Voucher record id ### mba-cli voucher get-by-code Get one voucher by voucher code Get single voucher resource by its unique code Get a single voucher resource by its unique code Get one voucher by voucher code Flags: - `--code` (string): Voucher code - `--team-id` (string): Team id scoping the lookup ### mba-cli voucher ls List vouchers Get all voucher resources Get all the voucher resources List vouchers Flags: - `--all` (bool, default `false`): Return all vouchers (paginate=false) - `--limit` (int, default `20`): Items per page - `--page` (int, default `1`): Page number ## weightclass Read weight classes ### mba-cli weightclass get Get one weight class by id Get single weight class resource Get a single weight class resource Get one weight class by id Flags: - `--id` (string): Weight class record id ### mba-cli weightclass get-by-size Get one weight class by size Get single weight class resource by its size Get a single weight class resource by its size Get one weight class by size Flags: - `--size` (string): Weight class size ### mba-cli weightclass get-by-weight Get one weight class by weight Get single weight class resource by its weight Get a single weight class resource by its weight Get one weight class by weight Flags: - `--weight` (string): Weight class weight ### mba-cli weightclass ls List weight classes Get all weight class resources Get all the weight class resources List weight classes Flags: - `--all` (bool, default `false`): Return all weight classes (paginate=false) - `--limit` (int, default `20`): Items per page - `--page` (int, default `1`): Page number