Sign in
Companies

List company users

Lists users in a company along with their roles and metadata.

post/companies/v1/users

Request body

company_idstring required

Required. The ID of the contractor company.

sort_field'USER_SORT_FIELD_USER_NAME'

ContractorCompanyUserSortField is used to define the sorting criteria of contractor company users.

  • USER_SORT_FIELD_USER_NAME: Sort by user name.
page_sizeinteger

The number of users to return in a single request.

page_tokenstring

If present, will fetch the next page of results. This must be the value of next_page_token from the response.

sort_direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'

Response

A successful response.

next_page_tokenstring

The next page token.