List a Contact's consent states
GET /v1/contacts/{contact_id}/consent
| Property | Value |
|---|---|
| Operation | list_contact_consent_states |
| Group | Contacts |
| Scope | contacts:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: Consent states carry identity ids and codes, never content. |
| Released in | 1.61.0 |
| Phase 0 host | Served (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"const response = await fetch(`${process.env.VOCAL_API}/v1/contacts/ctc_.../consent`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/contacts/ctc_.../consent",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
contact_id | path | ContactId | yes | The id of a Contact: ctc_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
limit | query | integer | no | The page size, 1 to 100. |
cursor | query | string | no | The opaque next_cursor of the previous page; it binds the filters it was issued under. |
channel | query | ConsentChannel | no | Only the states of this channel. |
Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | ConsentStateList | |
400 | application/json | ErrorEnvelope | invalid_request, invalid_cursor |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
404 | application/json | ErrorEnvelope | not_found |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is ConsentStateList.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of ConsentState | yes | The consent states of this page, newest first. |
has_more | boolean | yes | True when a further page exists. |
next_cursor | string or null | yes | The cursor of the next page, or null on the last page. |
object | "list" | yes |