Users and roles (partner)

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 which accounts and locations each one can see.

A partner user's access can be limited to specific accounts or locations. Two users at the same partner can see different lists everywhere in the API. Use this to give a sales rep their own customers, or an ops person a region.

You'll need a partner token.

Prerequisites

  • A bearer token in the Authorization header. 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

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

List users

GET — Get the users at your partner (or an account) with their role and what they can access.

Open →

Add a partner user

POST — Add a person at your partner with a role and access to chosen accounts or locations.

Open →

Get one user

POST — Get a user's details, role, and access.

Open →

Edit a partner user

POST — Change a user's details, role, or access scope.

Open →


Did this page help you?