Skip to main content

Get Multi Company

POST 
/v1/crm/company/get-multi

Retrieves companies by id, including the field schemas for the fields present on them. Use fieldMask.paths to limit which fields are returned, naming each as a fields.<fieldId> path (fields.<externalId> is accepted too); a read mask requires the fields.<...> form, and a bare id matches nothing. 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.