List cue rows
Show module
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.
- Requires the capability show.run_of_show.read.
- OAuth scopes: show.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: 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).Constraints: 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. |
Response 200: a page of Cue
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the cue. |
| 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. |
| run_of_show_id | string (uuid) | Yes | Identifier of the run of show. |
| position | integer | Yes | Cue order.Constraints: range 1 to any |
| label | string | Yes | Cue title.Constraints: length 1 to 300 |
| planned_at | string (date-time) | null | Yes | Planned cue time. |
| called_at | string (date-time) | null | Yes | When the cue was called. |
| duration | string | null | Yes | Planned length as hours:minutes:seconds.Constraints: pattern ^\d{2,}:\d{2}:\d{2}(\.\d+)?$ |
| called_by | string (uuid) | null | Yes | Identifier of the person who called the cue, set by app.call_cue. |
| project_id | string (uuid) | Yes | Identifier of the project of the running order, stamped by the database. |
| segment | string | null | Yes | Show segment the cue belongs to.Constraints: length 1 to 200 |
| description | string | null | Yes | What happens on the cue.Constraints: length 1 to 2000 |
| space_id | string (uuid) | null | Yes | 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
}Code samples
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