List shift rows

Módulo Crew

GET/shiftsshifts.list

A staffed crew block. A shift cannot end before it starts. Returns a cursor page of shift rows the caller may see. The default order is `starts_at` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad crew.shift.read.
Alcances de OAuth: crew.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

shifts.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de Shift

shifts.list: 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

{
  "data": [
    {
      "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
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/shifts" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.shifts.listAll()) {
  console.log(row);
}

for row in xos.shifts.list_all():
    print(row)

xos shifts list --all