Saltar al contenido

Get a DSAR request

Módulo Settings

GET/dsar-requests/{id}dsarRequests.get

A data subject access request. Returns one DSAR request with its `ETag`. A DSAR request the caller may not see returns 404.

  • Requiere la capacidad data.request.manage.
  • Alcances de OAuth: data.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

dsarRequests.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the dsar request.
fieldsFieldsNoSparse 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_]*)*$

Respuesta 200: DsarRequest

dsarRequests.get: DsarRequest
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the dsar request.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
request_type"Access" | "Rectification" | "Erasure" | "Restriction" | "Portability" | "Objection" | "Opt Out of Sale"SíWhat the requester exercises.
dsar_statestringSíRequest state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
subject_person_idstring (uuid) | nullSíIdentifier of the person the request is about, when they have an account.
subject_emailstring (email)SíEmail the requester gave, used to verify identity and to reply.
detailsstring | nullSíWhat the requester asked for, in their words.Restricciones: length 1 to 4000
received_atstring (date-time)SíWhen the request was received; the clock starts here.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "request_type": "Access",
  "dsar_state": "In Review",
  "subject_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "subject_email": "alex.rivera@northwindlive.example",
  "details": "Send me my timesheets.",
  "received_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/dsar-requests/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.dsarRequests.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.dsar_requests.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos dsar-requests get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f