# MyBusiness App Developer Documentation

> A read-only REST API for tenants, customers, bookings, invoices and more — plus `mba-cli` for the terminal. Both cover the same API surface, generated from one OpenAPI spec.

The API is read-only. The tenant API key scopes every request to its own tenant; there is no per-user login.

Base URL: `https://mpp-api-mybusinessapp-san.azure-api.net/v2`

Public subscription key (Ocp-Apim-Subscription-Key): `4fb0f9a3b14a44e98698e80cef2aebeb`

API version: `3.55.133`

## Getting started

- [Overview](https://mybusinessapp.co.za/developers): what the developer portal covers.
- [Authentication](https://mybusinessapp.co.za/developers/authentication): create an API key, send both headers, and understand scopes and tenant scoping.
- [Errors](https://mybusinessapp.co.za/developers/errors): the error envelope and every HTTP status code.
- [Pagination & filtering](https://mybusinessapp.co.za/developers/pagination): page, limit, paginate=false, and endpoint-specific filters.
- [Rate limits](https://mybusinessapp.co.za/developers/rate-limits): per-key limits and handling 429.
- [Versioning](https://mybusinessapp.co.za/developers/versioning): semantic versioning and breaking changes.
- [Glossary](https://mybusinessapp.co.za/developers/glossary): the terms used across these docs.
- [Changelog](https://mybusinessapp.co.za/developers/changelog): where to find the release notes.

## API reference

- [Addresses](https://mybusinessapp.co.za/developers/api/address): List and retrieve the addresses recorded for a tenant.
- [Application stamps](https://mybusinessapp.co.za/developers/api/application-stamp): Inspect the application stamps (deployment configuration) available to an API key.
- [Applications](https://mybusinessapp.co.za/developers/api/application): List the applications provisioned for a tenant.
- [Billing accounts](https://mybusinessapp.co.za/developers/api/billing-account): Billing accounts, invoices, subscriptions and transactions for a tenant.
- [Bookings](https://mybusinessapp.co.za/developers/api/booking): List, search and retrieve the bookings recorded for a tenant.
- [Breeds](https://mybusinessapp.co.za/developers/api/breed): Browse the breed catalogue by id, unique name or size.
- [Customers](https://mybusinessapp.co.za/developers/api/customer): List, search and retrieve customer profiles, with team and custom-field filters.
- [Documents](https://mybusinessapp.co.za/developers/api/document): List documents and retrieve them by id or by reference.
- [Employees](https://mybusinessapp.co.za/developers/api/employee): List and retrieve employees, including by Firebase UID.
- [API keys](https://mybusinessapp.co.za/developers/api/api-key): List API key metadata and read daily or monthly usage. Secret values are never returned.
- [Pets](https://mybusinessapp.co.za/developers/api/pet): List and retrieve the pets recorded for a tenant.
- [Services](https://mybusinessapp.co.za/developers/api/service): List and retrieve the services a tenant offers.
- [Stamps](https://mybusinessapp.co.za/developers/api/stamp): List and retrieve stamps and their deployment configuration.
- [Teams](https://mybusinessapp.co.za/developers/api/team): List and retrieve a tenant's teams.
- [Tenants](https://mybusinessapp.co.za/developers/api/tenant): List tenants and retrieve one by record id or tenant id.
- [Transports](https://mybusinessapp.co.za/developers/api/transport): List and retrieve the transport modes a tenant offers.
- [Vouchers](https://mybusinessapp.co.za/developers/api/voucher): List and retrieve vouchers, including by voucher code.
- [Weight classes](https://mybusinessapp.co.za/developers/api/weight-class): List and retrieve weight classes by id, size or weight.

## CLI

- [CLI getting started](https://mybusinessapp.co.za/developers/cli): install, authenticate, and run common tasks.
- [Command reference](https://mybusinessapp.co.za/developers/cli/reference): every command, option, and the API endpoint it calls.

## Machine-readable

- [OpenAPI document](https://mpp-api-mybusinessapp-san.azure-api.net/studio/v2/developers/openapi.json)
- [llms.txt](https://mybusinessapp.co.za/developers/llms.txt)
- [Full documentation](https://mybusinessapp.co.za/developers/llms-full.txt)

---

[Rendered page](https://mybusinessapp.co.za/developers)

© MyBusinessApp (Pty) Ltd. Proprietary documentation — do not republish.
