Skip to main content

List Companies

POST 
/v1/crm/company/list

Lists companies in a namespace with optional free-text search, filtering, sorting, and pagination. filtersV2 and sortBy address fields by fieldId, which the field-schema list endpoint supplies. In filtersV2 a schema's external id is accepted in place of the field id and resolved to it, and an id matching no schema is rejected with INVALID_ARGUMENT rather than ignored. sortBy does not resolve external ids: it matches on fieldId alone, and a sort naming an external id or an id matching no schema is ignored rather than rejected. A company's related contacts and opportunities are relationships held as associations, not fields on the company. Retrieve them from the association list endpoint, narrowing filtersV2 with a filter on field id association_type plus one naming the company: for value Contact-Company set field id to_id to the company id, and for value Company-Opportunity set field id from_id to the company id. These filter field ids are literal values, in snake_case, and are not camel-cased the way JSON property names are.

Request​

Responses​

A successful response.