Skip to content

Approve a time off request

Crew module

POST/time-off-requests/{id}/approvetimeOffRequests.approve

Records an approval decision on the time off request. The submitter cannot approve it. Spend authority and separation of duties are enforced in the approval RPC; a refusal returns 422 and names the rule. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability crew.time_off.approve.
  • OAuth scopes: crew.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

timeOffRequests.approve: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the time off request.

Response 200: TimeOffRequest

timeOffRequests.approve: TimeOffRequest
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the time off request.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
time_off_policy_idstring (uuid)YesIdentifier of the time off policy.
starts_onstring (date)YesFirst day off.
ends_onstring (date)YesLast day off.
time_off_state"Proposed" | "Approved" | "Rejected" | "Canceled"YesRequest state.
membership_idstring (uuid)YesIdentifier of the membership of the person requesting.
hoursnumberYesHours 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/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/approve" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.timeOffRequests.approve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.time_off_requests.approve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos time-off-requests approve 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f