# Bookings API

> List, search and retrieve the bookings recorded for a tenant.

List, search and retrieve the bookings recorded for a tenant.

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

API version: `3.55.133`

## Endpoints

### 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

---

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

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