List contacts

Returns a paginated list of contacts, with optional filters, sorting and a free-text search.

Endpoint

GET
/contacts

Query parameters

NameTypeRequiredDescription
organization_idintegerNoOnly contacts of this organization. Required when you use searchTerm.
any contact fieldmixedNoFilter with Feathers syntax, e.g. email=jane@example.com, system_type=lead, owned_by_user_id[$in][]=789, created_at[$gte]=2026-01-01.
tag_ids[]integer[]NoOnly contacts that have at least one of these tag IDs.
searchTermstringNoFree-text search (at least 3 characters). Requires organization_id and searchIn.
searchInstringWith searchTermWhere to search: all, name, phone, email or custom_field.
custom_field_namestringWith searchIn=custom_fieldName of the custom field to search in.
view_idintegerNoApply the filters of a saved contacts view.
fastJoinForContactListstringNoSet to true to embed company and owner objects in each contact.
$limitintegerNoPage size. Default 10, max 50.
$skipintegerNoNumber of records to skip.
$sort[field]1 | -1NoSort ascending or descending, e.g. $sort[created_at]=-1.
$select[]stringNoOnly return these fields.

Request

Search by phone:

Response

json

Each item is a full contact object; it is shortened here.

Notes

  • With searchTerm, results are sorted by first_name unless you pass $sort on first_name, last_name, email, created_at or updated_at. Terms shorter than 3 characters (or a lone + or digit) return an empty page.
  • searchIn=all also matches custom field values when the term has 4 or more characters.

Report an issue with this documentation

Please log in to report issues with our documentation.