Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.

Query Parameters

q
string

Substring of the email, the phone or an attribute value.

Maximum string length: 254
optedOut
enum<string>

Only contacts opted out of marketing on this channel.

Available options:
email,
sms
limit
integer
default:50
Required range: 1 <= x <= 200
cursor
string

The nextCursor of the previous page.

Response

200 - application/json

A page of contacts

data
object[]
required
nextCursor
string | null
required