Skip to main content
GET
Retrieve Users for a Managed Company

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

company-id
string<uuid>
required

Managing Company ID

managed-company-id
string<uuid>
required

Managed Company ID

Query Parameters

page[limit]
integer<int32>
default:25

The maximum number of paginated results to return

Required range: x <= 100
page[after]
string

The cursor to start paginating after

page[before]
string

The cursor to stop paginating at

search[datagrid]
string

Search string for datagrid queries

filter[access]
enum<string>

User access filter

Available options:
execute_jobs,
manage_sites,
manage_materials,
manage_equipment,
manage_accounts,
manage_users
filter[iam_roles]
array

The IamRoles of the User. Allowed values: platform_admin, company_admin, dispatcher, biller, foreman, driver, it_admin, manager

Response

OK

data
User-Read · object[]
required