List companies

post

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

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

Lists companies based on applied filters. You can filter by search term, company type, status, compliance issues, and address. Results support sorting and pagination.

📘
If you don't have the "Companies: Manage" permission, the response will only include companies you have access to.

Requirements

An authenticated API request. See Authentication.

Body Params

filter

object

ContractorCompanyFilter is used to filter contractor companies.

sort_field

string

enum

ContractorCompanySortField is used to define the sorting criteria of contractor companies.

COMPANY_SORT_FIELD_COMPANY_TYPE_NAME: Sort by company type name.
COMPANY_SORT_FIELD_COMPANY_NAME: Sort by company name.
COMPANY_SORT_FIELD_COMPANY_STATUS: Sort by company status.

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

Loading…

Response

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

application/json

Requirements

200A successful response.

defaultAn unexpected error response.