List support session rows

Módulo Platform

GET/support-sessionssupportSessions.list

A support session (1060): the client org's Owner lets its partner's staff read the client org for 1 to 24 hours. Partner staff read nothing of a client without one; they never write. Created with supportSessions.grant and ended early with supportSessions.end. Returns a cursor page of support session rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

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

supportSessions.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 SupportSession

supportSessions.list: SupportSession
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the support session.
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.
grantee_org_id	string (uuid)	Sí	Identifier of the partner org whose staff may read while the session lasts.
reason	string	Sí	Why the session was granted.Restricciones: length 1 to 500
starts_at	string (date-time)	Sí	When access began.
ends_at	string (date-time)	Sí	When access ends on its own, at most 24 hours after it began.
ended_at	string (date-time) \| null	Sí	When someone ended the session early.
ended_by	string (uuid) \| null	Sí	Identifier of the person who ended it early.

{
  "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",
      "grantee_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "reason": "Help with the venue import.",
      "starts_at": "2026-10-08T14:30:00Z",
      "ends_at": "2026-10-08T14:30:00Z",
      "ended_at": "2026-10-08T14:30:00Z",
      "ended_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos support-sessions list --all