List contacts
Contacts
List contacts
Retrieve a paginated list of contacts. Optionally filter by email, phone number, or consent status.
Required scope: contacts_read
GET
List contacts
Authorizations
Send either an API token or an OAuth access token as
Authorization: Bearer <token>. See the Authentication page for details.
Query Parameters
Page number (starts at 1).
Required range:
x >= 1Number of results per page.
Required range:
1 <= x <= 100Filter by exact email address.
Filter by exact phone number (E.164 format).
Filter by email consent status. subscribed matches both explicit
and implicit opt-in. suppressed matches merchant-suppressed contacts
only; compliance_suppressed matches system/compliance-suppressed contacts.
Available options:
subscribed, unsubscribed, never_subscribed, suppressed, compliance_suppressed Filter by SMS consent status.
Available options:
subscribed, unsubscribed, never_subscribed, single_opt_in, pending