Get a consent record
Settings module
GET/consent-records/{id}consentRecords.get
A consent given or withdrawn. Returns one consent record with its `ETag`. A consent record the caller may not see returns 404.
- Requires the capability data.request.manage.
- OAuth scopes: data.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the consent record. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: ConsentRecord
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the consent record. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| person_id | string (uuid) | Yes | Identifier of the person. |
| purpose_code | string | Yes | Consent purpose.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| notice_version | string | Yes | Version of the notice shown when consent was given.Constraints: length 1 to 300 |
| source | "Web" | "Mobile" | "Email" | "SMS" | "Import" | "Support" | Yes | Where consent was captured. |
| captured_at | string (date-time) | Yes | When consent was given, set by the database. |
| captured_ip | string | null | Yes | Client IP address at capture, set by the database.Constraints: length 1 to 300 |
| withdrawn_at | string (date-time) | null | Yes | When the person withdrew consent; null while it stands. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"purpose_code": "marketing_email",
"notice_version": "2026-10-01",
"source": "Web",
"captured_at": "2026-10-08T14:30:00Z",
"captured_ip": "203.0.113.24",
"withdrawn_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/consent-records/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.consentRecords.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.consent_records.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos consent-records get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f