API ReferenceContacts

List contacts

View as Markdown

Returns workspace contacts using cursor pagination ordered by updated_at descending by default. filter[crm_associations][eq] supports only CRM objects with object_type=contact. Requires the contacts:read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional1-100Defaults to 25
Maximum number of results to return. Defaults to 25 and is capped at 100.
cursorstringOptional
Opaque cursor from a previous list response.
searchstringOptional

Free-text search string matched against contact full names and email addresses. This does not search phone numbers, descriptions, or company data.

order_byenumOptional

Sort order for the list. Defaults to updated_at:desc.

Allowed values:
filter[crm_associations][eq]stringOptional
Filter resources by CRM associations. For readability, docs examples use indexed bracket syntax such as `filter[crm_associations][eq][0][id]=123` plus `filter[crm_associations][eq][0][object_type]=<supported-object-type>`. The API also accepts a JSON-encoded array string with objects containing `id` and `object_type`. CRM source is inferred from the workspace's connected CRM state. Supported `object_type` values depend on the endpoint. Supports up to 20 objects.
filter[updated_at][gt]datetimeOptional

Return resources updated strictly after the provided ISO-8601 UTC timestamp.

filter[updated_at][gte]datetimeOptional

Return resources updated at or after the provided ISO-8601 UTC timestamp.

filter[updated_at][lt]datetimeOptional

Return resources updated strictly before the provided ISO-8601 UTC timestamp.

filter[updated_at][lte]datetimeOptional

Return resources updated at or before the provided ISO-8601 UTC timestamp.

Response headers

X-Api-Versionstring

Response

Paginated contacts list.
objectenum
Resource discriminator for list responses.
Allowed values:
datalist of objects
Contact records in the current page.
has_moreboolean
Indicates whether another page of contacts is available.
next_cursorstring or null

Opaque cursor for the next page, or null when there are no more results.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error