Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Query Parameters

q
string

Name, account number, external ref, email, or any channel value.

status
string
tag
string

Contacts carrying this tag.

assignedTo
string<uuid>

Ignored unless it is a UUID.

dnc
enum<string>

Filter on the person-level do-not-contact decision.

Available options:
true,
false
limit
integer
default:50
Required range: 1 <= x <= 200
offset
integer
default:0

Response

Contacts, newest first, with the total the filter matched.

accounts
object[]
total
integer