Get a shift
Módulo Crew
GET/shifts/{id}shifts.get
A staffed crew block. A shift cannot end before it starts. Returns one shift with its `ETag`. A shift the caller may not see returns 404.
- Requiere la capacidad crew.shift.read.
- Alcances de OAuth: crew.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the shift. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: Shift
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the shift. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| project_id | string (uuid) | Sí | Identifier of the project. |
| record_id | string (uuid) | null | Sí | Identifier of the Shift record. |
| role_code | RoleCode | null | Sí | |
| engagement_id | string (uuid) | null | Sí | Identifier of the engagement. |
| starts_at | string (date-time) | Sí | Call time. |
| ends_at | string (date-time) | Sí | Wrap time. |
| shift_state | "Draft" | "Published" | "Accepted" | "Canceled" | Sí | Shift state. |
| membership_id | string (uuid) | null | Sí | Identifier of the membership of the person on the shift; null for external crew, who carry an engagement. |
| scope_node_id | string (uuid) | null | Sí | Identifier of the scope node of the same project, such as the show. |
| time_zone | string | Sí | IANA time zone the call and wrap times are shown in.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| scheduled_break_minutes | integer | null | Sí | Meal break scheduled within the shift, in minutes.Restricciones: range 0 to any |
{
"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": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"starts_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z",
"shift_state": "Draft",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"time_zone": "America/New_York",
"scheduled_break_minutes": 30
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/shifts/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.shifts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.shifts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos shifts get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f