Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

Send either an API token or an OAuth access token as Authorization: Bearer <token>. See the Authentication page for details.

Query Parameters

page
integer
default:1

Page number (starts at 1).

Required range: x >= 1
per_page
integer
default:25

Number of results per page.

Required range: 1 <= x <= 100
email
string<email>

Filter by exact email address.

phone_number
string

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

Response

A paginated list of contacts.

data
object[]
pagination
object