List companies

post

https://api.safetyculture.io/companies/v1beta/companies

Lists contractor companies based on applied filters, with support for sorting and pagination.

Body Params

filter

object

Additional filters to apply to the request.

sort_field

string

enum

The field to sort by.

Allowed:

sort_direction

string

enum

Defaults to SORT_DIRECTION_UNSPECIFIED

The sort order.

Allowed:

page_size

int32

The number of companies 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.

include_compliance_stats

boolean

Deprecated. This does nothing. Compliance statistics are now always included in the response.

include_user_credential_compliance_stats

boolean

Temporary migration flag. When true, includes user credential compliance statistics in the response. Defaults to false.

Responses

Language

Credentials

Bearer

Response

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

application/json

200A successful response.