Skip to main content

List Contacts

POST 
/v1/crm/contact/list

Lists contacts 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 contact's opportunities and companies are relationships held as associations, not fields on the contact. Retrieve them from the association list endpoint, narrowing filtersV2 with a filter on field id association_type (value Contact-Opportunity or Contact-Company) and one on field id from_id set to the contact id. These filter field ids are literal values, in snake_case, and are not camel-cased the way JSON property names are. The contact's primary company is additionally mirrored onto the standard__contact_primary_company_id field, but that field is a denormalized copy kept for filtering and covers only the primary company; the Contact-Company association remains the source of truth, so resolve or verify a contact's company through the association rather than the field alone.

Request​

Responses​

A successful response.