Claim an open shift
Crew module
POST/shifts/{id}/claimshifts.claim
Claims a published shift that has no one on it for the caller's own membership, under the project's claiming rule (scheduling.open_shift_claiming). Under first-come the caller gets the shift at once: it becomes Accepted and `claim` is null. Under approval, the default, or seniority the claim waits for a supervisor: the shift stays Published with no one on it and `claim` carries the waiting claim. A second claim on the shift while the caller's first one waits is refused (422, shift_claim_waiting). A held, unpublished or overlapping shift is refused (422). 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.shift.read.
- 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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the shift. |
Response 200: ShiftClaimResult
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the shift. |
| 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. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| record_id | string (uuid) | null | Yes | Identifier of the Shift record. |
| role_code | RoleCode | null | Yes | |
| engagement_id | string (uuid) | null | Yes | Identifier of the engagement. |
| starts_at | string (date-time) | Yes | Call time. |
| ends_at | string (date-time) | Yes | Wrap time. |
| shift_state | "Draft" | "Published" | "Accepted" | "Canceled" | Yes | Shift state. |
| membership_id | string (uuid) | null | Yes | Identifier of the membership of the person on the shift; null for external crew, who carry an engagement. |
| scope_node_id | string (uuid) | null | Yes | Identifier of the scope node of the same project, such as the show. |
| time_zone | string | Yes | IANA time zone the call and wrap times are shown in.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| scheduled_break_minutes | integer | null | Yes | Meal break scheduled within the shift, in minutes.Constraints: range 0 to any |
| claim | object | null | Yes | The caller's waiting claim when the claiming rule is approval or seniority; null when the caller got the shift (first-come). |
{
"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",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_code": "5000.50.01",
"engagement_id": null,
"starts_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z",
"shift_state": "Published",
"membership_id": null,
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"time_zone": "America/New_York",
"scheduled_break_minutes": 30,
"claim": {
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"claim_state": "Requested"
}
}Code samples
curl -X POST "$XOS_BASE_URL/shifts/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/claim" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.shifts.claim("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.shifts.claim("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos shifts claim 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f