Get a DSAR request
Settings module
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.
- 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 dsar request. |
| 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: DsarRequest
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the dsar request. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | 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" | Yes | What the requester exercises. |
| dsar_state | string | Yes | Request state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| subject_person_id | string (uuid) | null | Yes | Identifier of the person the request is about, when they have an account. |
| subject_email | string (email) | Yes | Email the requester gave, used to verify identity and to reply. |
| details | string | null | Yes | What the requester asked for, in their words.Constraints: length 1 to 4000 |
| received_at | string (date-time) | Yes | 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"
}Code samples
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