Skip to main content
GET
cURL

Authorizations

apiKey
string
header
required

API key to authorize requests

Query Parameters

listId
string
required

Filter contacts by list ID

limit
integer<int32>

The maximum number of results to return (default and max: 20000)

page
integer<int32>

Page number for pagination

sort
enum<string>

Field to sort by (default sorts by points and createdAt)

Available options:
points,
createdAt,
email,
firstName,
lastName,
position
order
enum<string>

Sort order (default: desc)

Available options:
asc,
desc
email
string

Filter contacts by email (partial match, case-insensitive)

firstName
string

Filter contacts by first name (partial match, case-insensitive)

lastName
string

Filter contacts by last name (partial match, case-insensitive)

phoneNumber
string

Filter contacts by phone number (partial match, case-insensitive)

name
string

Filter contacts by full name (partial match, case-insensitive)

company
string

Filter contacts by company (partial match, case-insensitive)

country
string

Filter contacts by country (partial match, case-insensitive)

city
string

Filter contacts by city (partial match, case-insensitive)

instagram
string

Filter contacts by Instagram handle (partial match, case-insensitive)

twitter
string

Filter contacts by Twitter handle (partial match, case-insensitive)

website
string

Filter contacts by website URL (partial match, case-insensitive)

isVerified
boolean

Filter contacts by verification status

unsubscribed
boolean

Filter contacts by subscription status

isGDPR
boolean

Filter contacts by GDPR consent status

Response

Contacts response

data
object