List company users

post

https://api.safetyculture.io/companies/v1/users

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

Lists a company's users along with their roles and metadata. You can filter by search term and user status, and paginate the results.

Body Params

company_id

string

required

Required. The ID of the contractor company.

filter

object

ContractorCompanyUserFilter is used to filter contractor company users.

sort_field

string

enum

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

Allowed:

page_size

int32

The number of users to return in a single request.

page_token

string

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

sort_direction

string

enum

Defaults to SORT_DIRECTION_UNSPECIFIED

Optional. The sort order to apply. Defaults to ascending when unspecified.

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.