Create a time off request
Crew module
POST/time-off-requeststimeOffRequests.create
A time off request. The submitter cannot approve it. Creates a time off request. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability crew.time_off.request.
- OAuth scopes: crew.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: TimeOffRequestCreate
| Field | Type | Required | Description |
|---|---|---|---|
| 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. |
| membership_id | string (uuid) | Yes | Identifier of the membership of the person requesting. |
| hours | number | Yes | Hours requested. |
{
"time_off_policy_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"starts_on": "2026-10-08",
"ends_on": "2026-10-08",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"hours": 16
}Response 201: 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 POST "$XOS_BASE_URL/time-off-requests" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"time_off_policy_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","starts_on":"2026-10-08","ends_on":"2026-10-08","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","hours":16}'const { data } = await xos.timeOffRequests.create({
"time_off_policy_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"starts_on": "2026-10-08",
"ends_on": "2026-10-08",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"hours": 16
});response = xos.time_off_requests.create({"time_off_policy_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "starts_on": "2026-10-08", "ends_on": "2026-10-08", "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "hours": 16})xos time-off-requests create --data '{"time_off_policy_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","starts_on":"2026-10-08","ends_on":"2026-10-08","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","hours":16}'