Skip to main content
GET
Fetch one contact

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Response

The contact.

id
string<uuid>
externalRef
string | null

An integrator's own key. Only ever compared, never interpreted.

accountNumber
string | null
firstName
string | null
lastName
string | null
displayName
string | null
email
string | null
timezone
string | null

IANA zone. Injected as tz on every campaign row.

dateOfBirth
string | null
ssnMasked
string | null

Always masked, e.g. ***-**-1234. Only four digits are stored; one place decides how to present them.

address
object
status
string | null
assignedTo
string<uuid> | null
tags
string[]
notes
string | null
lastContactedAt
string<date-time> | null
lastContactChannel
string | null
doNotContact
boolean

The person-level decision. Distinct from the address suppression list.

dncReason
string | null
dncSetAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time> | null
channels
object[]