Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Query Parameters

cursor
string

Opaque cursor for the next page (from previous response meta.pagination.cursor)

limit
default:25

Number of items per page (default 25). Values above the page-size cap are silently clamped; negative, fractional, or unparseable values fall back to the default. Never 422s.

Required range: x >= 1

Free-text search across name, phone, email

lifecycle_stage
string

Filter by lifecycle stage

country_code
string

Filter by country code

company
string

Filter by company (contains)

tags
string

Comma-separated tag filter

has_phone
boolean

Only contacts with a phone number

has_email
boolean

Only contacts with an email address

created_after
string<date-time>

Created after this date

created_before
string<date-time>

Created before this date

has_custom_field
string

Only contacts that have this custom-field key populated (in attributes or custom_attributes)

Response

Paginated list of contacts

Paginated list of contacts

data
object[]
meta
object