# Customers API

> List, search and retrieve customer profiles, with team and custom-field filters.

List, search and retrieve customer profiles, with team and custom-field filters.

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

API version: `3.55.133`

## Endpoints

### 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_<fieldId>`). 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

---

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

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