Get a time off request
Crew module
GET/time-off-requests/{id}timeOffRequests.get
A time off request. The submitter cannot approve it. Returns one time off request with its `ETag`. A time off request the caller may not see returns 404.
- Requires the capability crew.schedule.read.
- OAuth scopes: crew.
- 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 time off 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: TimeOffRequest
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the time off 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. |
| time_off_policy_id | string (uuid) | Yes | Identifier of the time off policy. |
| starts_on | string (date) | Yes | First day off. |
| ends_on | string (date) | Yes | Last day off. |
| time_off_state | "Proposed" | "Approved" | "Rejected" | "Canceled" | Yes | Request state. |
| membership_id | string (uuid) | Yes | Identifier of the membership of the person requesting. |
| hours | number | Yes | Hours requested. |
{
"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",
"time_off_policy_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"starts_on": "2026-10-08",
"ends_on": "2026-10-08",
"time_off_state": "Proposed",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"hours": 16
}Code samples
curl -X GET "$XOS_BASE_URL/time-off-requests/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.timeOffRequests.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.time_off_requests.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos time-off-requests get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f