Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Contacts

Get a contact's statuses

<small>Requires the contacts:read scope (or a broader one that includes it).</small>

Returns the contact's current global flags (isOptedOut, callStatus, meetingStatus) plus per-sequence status (statusInSequence) and email disposition (isReplied, isBounced) for each sequence the contact is enrolled in.

get/v3/contacts/{id}/statuses

Path parameters

idinteger required

Contact ID

Response

Contact statuses retrieved successfully

contactIdinteger required

Contact ID

isOptedOutboolean required

Whether the contact has opted out of all communications

callStatus'none' | 'toCall' | 'called' required

Contact-level call status. Set via PATCH /v3/contacts/{id} (callStatus field). Pass none to clear.

meetingStatus'none' | 'meetingBooked' required

Contact-level meeting status. Set via PATCH /v3/contacts/{id} (meetingStatus field). Pass none to clear.