Add people at your partner who can use the dashboard and the API, and control what each one can see.
Add people at your partner who can use the dashboard and the API, and control what each one can see.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | List users | List every non-deleted user in the authenticated caller's company with their role, assigned locations and assigned accounts. |
POST | Add a partner user | Create a new user under the authenticated partner company, sets their role (admin / assign_brand / basic), optionally assigns account access and default reports, and emails first-login credentials via the white-label-aware welcome email. |
POST | Get one user | Returns the full detail of a single partner user (identified by user_id) including derived user_type, role, assigned locations and assigned accounts. |
POST | Edit a partner user | Update an existing partner user's name/title, role, account assignments, optional password and deactivation date. |