CHcheckhq

List companies

Changed on

Returns a list of all companies.

get/companies

Request

Query parameters

activeboolean

Filter companies by whether they are active or not active.

limitinteger

Number of companies returned per page. The maximum value is 25.

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

metadataobject

Return only results whose metadata contains every given key and value, for example metadata[external_id]=123. Pass keys using bracket notation. Multiple keys are combined with AND. Brackets must be URL-encoded in request URLs (metadata%5Bkey%5D=value).

Response

200

object required

Changes