Users & roles

Partner/account company-admin user management (bearer token whose user's company is a partner bundle_id=1 or account bundle_id=3).

Partner/account company-admin user management (bearer token whose user's company is a partner bundle_id=1 or account bundle_id=3). List all users in the company with roles/locations/accounts (GET users/list), create (POST users/partner/add) and edit (POST users/partner/edit) partner users, fetch a single partner user's details (POST users/partner/details), and impersonate a child company/user or parent partner user (POST users/impersonate). No throttle; scope enforced in-controller and via an ownership check.

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

MethodEndpointDescription
GETList company users (roles, locations, accounts)List every non-deleted user in the authenticated caller's company with their role, assigned locations and assigned accounts.
POSTCreate partner userCreate 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.
POSTEdit partner userUpdate an existing partner user's name/title, role, account assignments, optional password and deactivation date.
POSTGet partner user detailsReturns the full detail of a single partner user (identified by user_id) including derived user_type, role, assigned locations and assigned accounts.
POSTImpersonate user or company ownerMint a login token that lets the caller act as another user or a company's owner.