Skip to main content
GET
List Contacts
Filter by sourceKey, externalId, phoneNumber, or email. All supplied filters must match. externalId requires sourceKey; email matching is case-insensitive. Phone numbers use E.164 format. URL-encode a leading plus sign as %2B.
The response contains data, hasMore, and nextCursor. Each contact has the same profile fields as Get Contact, including consent records for its current phone number. Only active contacts in your organization are included. No matches returns an empty data array. Results are ordered by UUID. Set limit between 1 and 100 (default 50). When hasMore is true, pass after with the returned nextCursor, keeping the same filters, to fetch the next page.

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer YOUR_API_KEY

Query Parameters

sourceKey
string

Stable lowercase snake_case identifier for the source.

Required string length: 1 - 63
Pattern: ^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$
externalId
string
Required string length: 1 - 1000
phoneNumber
string
Pattern: ^\+[1-9]\d{1,14}$
email
string<email>
limit
integer
default:50
Required range: 1 <= x <= 100
after
string<uuid>

Response

List Contacts

data
Synced Contact · object[]
required
hasMore
boolean
required
nextCursor
string<uuid> | null
required
Last modified on September 17, 2026