List support ticket rows
Módulo Platform
GET/support-ticketssupportTickets.list
A request for help (0643): to the org's own admins (Organization queue) or, from holders of org.help.write, to the platform team (Platform queue), whose channel and first response deadline follow the plan. Readable by the requester and by those who answer support for the org. Returns a cursor page of support ticket rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad me.account.write.
- Alcances de OAuth: me.
- 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
| 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 SupportTicket
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the support ticket. |
| 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. |
| 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. |
| membership_id | string (uuid) | Sí | Identifier of the membership of the requester, set by the server. |
| ticket_number | string | Sí | Display number, SUP-0001 upward per org.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| queue | "Organization" | "Platform" | Sí | Organization or Platform. |
| category | "Question" | "Problem" | "Access" | "Billing" | "Account" | "Feature Request" | Sí | What the request is about. |
| severity | "Severity 1" | "Severity 2" | "Severity 3" | "Severity 4" | Sí | Severity 1 (outage) to Severity 4 (question). |
| subject | string | Sí | One-line summary.Restricciones: length 1 to 200 |
| body | string | Sí | What happened and what the requester needs.Restricciones: length 1 to 20000 |
| ticket_state | "Open" | "Waiting" | "Resolved" | "Closed" | Sí | Open, Waiting, Resolved or Closed; moved by the transition action. |
| channel | "In App" | "Email" | "Chat" | "Priority Queue" | "Dedicated Channel" | Sí | In App for the Organization queue; by plan for the Platform queue. |
| first_response_due_at | string (date-time) | null | Sí | Platform first response deadline from the plan; null for best effort. |
| first_responded_at | string (date-time) | null | Sí | When a responder first answered. |
{
"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",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"ticket_number": "SUP-0001",
"queue": "Organization",
"category": "Access",
"severity": "Severity 3",
"subject": "Scanner shows an unknown zone",
"body": "At the north gate the scanner says the zone is unknown.",
"ticket_state": "Open",
"channel": "In App",
"first_response_due_at": "2026-10-08T14:30:00Z",
"first_responded_at": "2026-10-08T14:30:00Z"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/support-tickets" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.supportTickets.listAll()) {
console.log(row);
}for row in xos.support_tickets.list_all():
print(row)xos support-tickets list --all