# Transports API

> List and retrieve the transport modes a tenant offers.

List and retrieve the transport modes a tenant offers.

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

API version: `3.55.133`

## Endpoints

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

---

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

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