List cue rows

Módulo Show

GET/cuescues.list

A cue in a run of show. Returns a cursor page of cue rows the caller may see. The default order is `position` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad show.run_of_show.read.
Alcances de OAuth: show.
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

cues.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 Cue

cues.list: Cue
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the cue.
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.
run_of_show_id	string (uuid)	Sí	Identifier of the run of show.
position	integer	Sí	Cue order.Restricciones: range 1 to any
label	string	Sí	Cue title.Restricciones: length 1 to 300
planned_at	string (date-time) \| null	Sí	Planned cue time.
called_at	string (date-time) \| null	Sí	When the cue was called.
duration	string \| null	Sí	Planned length as hours:minutes:seconds.Restricciones: pattern ^\d{2,}:\d{2}:\d{2}(\.\d+)?$
called_by	string (uuid) \| null	Sí	Identifier of the person who called the cue, set by app.call_cue.
project_id	string (uuid)	Sí	Identifier of the project of the running order, stamped by the database.
segment	string \| null	Sí	Show segment the cue belongs to.Restricciones: length 1 to 200
description	string \| null	Sí	What happens on the cue.Restricciones: length 1 to 2000
space_id	string (uuid) \| null	Sí	Identifier of the space the cue happens in.

{
  "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",
      "run_of_show_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "position": 10,
      "label": "Headliner Walk-On",
      "planned_at": "2026-10-08T14:30:00Z",
      "called_at": "2026-10-08T14:30:00Z",
      "duration": "00:05:00",
      "called_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "segment": "Act II, Official Opening and Remarks",
      "description": "House lights to half; walk-in music fades.",
      "space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos cues list --all