List consent record rows
Módulo Settings
GET/consent-recordsconsentRecords.list
A consent given or withdrawn. Returns a cursor page of consent record rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad data.request.manage.
- Alcances de OAuth: data.
- Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
- Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Respuesta 200: una página de ConsentRecord
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the consent record. |
| created_at | string (date-time) | Sí | When the row was created. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| person_id | string (uuid) | Sí | Identifier of the person. |
| purpose_code | string | Sí | Consent purpose.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| notice_version | string | Sí | Version of the notice shown when consent was given.Restricciones: length 1 to 300 |
| source | "Web" | "Mobile" | "Email" | "SMS" | "Import" | "Support" | Sí | Where consent was captured. |
| captured_at | string (date-time) | Sí | When consent was given, set by the database. |
| captured_ip | string | null | Sí | Client IP address at capture, set by the database.Restricciones: length 1 to 300 |
| withdrawn_at | string (date-time) | null | Sí | When the person withdrew consent; null while it stands. |
{
"data": [
{
"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"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/consent-records" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.consentRecords.listAll()) {
console.log(row);
}for row in xos.consent_records.list_all():
print(row)xos consent-records list --all