get
/contactsGet contacts
Returns customer profiles with identities, tags, and custom fields. Use filters to find the segment you want to message, enroll in journeys, or keep in sync.
Authorization
Scheme
- bearerAuth
Required scopes
- contact:list
Allowed roles
- owner
- admin
- agent
List contacts in the caller's contact scope.
Parameters
- Name
pageToken- Type
- query string
- Description
- Opaque token from the previous response's `nextPageToken`.
- Name
pageSize- Type
- query integer
- Description
- Optional parameter.
- Name
search- Type
- query string
- Description
- Case-insensitive substring search across name, cf_email, cf_phone, identity phone, and tag name.
- Name
customFields- Type
- query object
- Description
- Filter by custom field values (AND logic)
- Name
tagIds- Type
- query array<string>
- Description
- Include contacts tagged with any of the listed tag IDs (OR semantics).
- Name
channels- Type
- query array<enum>
- Description
- Include contacts that have an identity on any of the listed channels (OR semantics).
- Name
archived- Type
- query boolean
- Description
- Tri-state filter. Omit to exclude archived contacts (default), set to true to return only archived contacts, or false to return only non-archived.
- Name
createdAfter- Type
- query string
- Description
- Inclusive lower bound on createdAt (RFC3339).
- Name
createdBefore- Type
- query string
- Description
- Exclusive upper bound on createdAt (RFC3339).
- Name
orderBy- Type
- query enum
- Description
- Optional parameter.
- Name
orderDirection- Type
- query enum
- Description
- Optional parameter.
Responses
- 200
List of contacts
- application/json ContactsResponse
- default
Error
- application/json ProblemDetails