VocalDocscontracts 1.65.0

List a Contact's consent states

GET /v1/contacts/{contact_id}/consent

PropertyValue
Operationlist_contact_consent_states
GroupContacts
Scopecontacts:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: Consent states carry identity ids and codes, never content.
Released in1.61.0
Phase 0 hostServed (the hosted api pins 1.65.0)

The derived states of a Contact's addresses and of its memory consent (1.61.0), each naming the identity it is about, never its value; not a content read.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the contacts:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/contacts/ctc_.../consent" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
contact_idpathContactIdyesThe id of a Contact: ctc_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
channelqueryConsentChannelnoOnly the states of this channel.

Responses

StatusContent typeShapeError codes
200application/jsonConsentStateList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is ConsentStateList.

FieldTypeRequiredDescription
dataarray of ConsentStateyesThe consent states of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes