v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB

Companies

List companies

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

post/companies/v1/companies

sort_field'COMPANY_SORT_FIELD_COMPANY_TYPE_NAME' | 'COMPANY_SORT_FIELD_COMPANY_NAME' | 'COMPANY_SORT_FIELD_COMPANY_STATUS'

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

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

page_sizeinteger

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

include_compliance_statsboolean

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

include_user_credential_compliance_statsboolean

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

A successful response.

next_page_tokenstring

The next page token.

total_countinteger

The total number of contractor companies that match the filter.

total_count_needs_attentioninteger

The total number of contractor companies that match the filter + need attention.