# Addresses API

> List and retrieve the addresses recorded for a tenant.

List and retrieve the addresses recorded for a tenant.

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

API version: `3.55.133`

## Endpoints

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

---

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

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