# Employees API

> List and retrieve employees, including by Firebase UID.

List and retrieve employees, including by Firebase UID.

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

API version: `3.55.133`

## Endpoints

### GET /employees

List employees

Returns the employees for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by team. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve an employee by id`, `Retrieve an employee by Firebase UID`.

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 employees per page
- `paginate` (query), optional — Enable or disable pagination
- `teamId` (query), optional — Filter employees by specific team ID
- `teamIds` (query), optional — Filter employees by multiple team IDs (comma-separated)

Reference: https://mybusinessapp.co.za/developers/api/employee#tag/Employee/get_all_employees

### GET /employees/uid/{uid}

Retrieve an employee by Firebase UID

Returns the employee with the given Firebase `uid` (useful when you only have the signed-in user's id). Related: `Retrieve an employee 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
- `uid` (path), required — Employee's unique identifier (UID)

Reference: https://mybusinessapp.co.za/developers/api/employee#tag/Employee/get_single_employee_by_uid

### GET /employees/{id}

Retrieve an employee by id

Returns the employee with the given `id`, including role assignments and team associations. Related: `List employees`.

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 — Employee's unique identifier

Reference: https://mybusinessapp.co.za/developers/api/employee#tag/Employee/get_single_employee

---

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

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