Get contacts
List the contacts in your CRM, returned oldest-first by creation date. The response is a page envelope: data holds the contacts and next_page is a ready-to-call URL for the following page (null on the last page).
This endpoint is eventually consistent — a contact you just created or edited may take up to 1 second to appear or reflect its new values here.
By default only non-deleted contacts are returned; use the deleted filter to include or isolate soft-deleted ones. Results are further scoped to your company and to the contacts the authenticated user may see under their team restrictions, so two users at the same company can get different lists.
Required permission: contacts_permissions_view.
Query parameters
Restrict the result to specific contacts by ID (the same ID returned as each contact's id). Repeat the bracketed key once per ID. Unknown IDs simply match nothing; an empty list is treated as no filter. At most 200 IDs may be given.
Restrict to contacts employed by specific companies by company ID (the same ID returned as each contact's company.id). Repeat the bracketed key once per ID; matches ANY. Unknown IDs match nothing; an empty list is no filter. At most 200 IDs.
Restrict to contacts owned by any of these Distru users (each contact's owner.id). Repeat the bracketed key once per ID; matches ANY. Unknown IDs match nothing; an empty list is no filter. At most 200 IDs.
Filter to contacts by their creation datetime. The value is a comma-separated start,end pair of ISO8601 datetimes and either bound may be omitted: 2022-07-10T00:00:00Z, returns contacts created on or after that instant, ,2022-07-10T00:00:00Z returns those created on or before it, and 2022-07-10T00:00:00Z,2022-07-11T00:00:00Z returns those created between the two (inclusive).
Whether soft-deleted contacts are included. no (the default) returns only non-deleted contacts, only returns only soft-deleted ones, and include returns both. Soft-deleted contacts carry a non-null deleted_at in the response.
Page selector. Page size is fixed by the server; paginate by following the next_page URL in each response rather than building page selectors yourself — it is null on the last page. next_page uses page[after]=<cursor>, an opaque token marking where the next page resumes; pass it back exactly as given, and only to the endpoint that issued it. This is seek-based, so every page stays fast no matter how deep you page.
Filter to contacts by the datetime they were last modified. Same comma-separated start,end ISO8601 format as inserted_datetime, with either bound optional: ,2022-07-10T00:00:00Z returns contacts last updated on or before that instant.
Filter by custom field values, as custom_data[{id}]=value where {id} is a custom field's numeric id. Repeat with different ids to filter on several fields at once; a record must match every one (AND). Matching is case-sensitive exact against the value stored on the record. The id must be a filterable custom field defined on this entity — use GET /public/v1/custom-fields?parent_object=contact to list the ids, their types, and which are filterable. A non-numeric id, an id not defined on this entity, or an id that isn't filterable returns a 400.
Response
A list of contacts
Changes
No recorded changes to this endpoint across all 1 revision of this API.