List help desk request rows

Módulo Workforce

GET/help-desk-requestshelpDeskRequests.list

A help desk request: an Organization queue support ticket routed to an internal team, with assignment and response deadline. Returns a cursor page of help desk request rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

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

helpDeskRequests.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 HelpDeskRequest

helpDeskRequests.list: HelpDeskRequest
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the help desk request.
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í	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Person who last updated the row; null for seed, platform or system writes.
ticket_number	string	Sí	Display number.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
help_desk_team_id	string (uuid)	Sí	Identifier of the team the request is routed to.
category	"Question" \| "Problem" \| "Access" \| "Billing" \| "Account" \| "Feature Request"	Sí	What it is about.
severity	"Severity 3" \| "Severity 1" \| "Severity 2" \| "Severity 4"	Sí	Severity.
subject	string	Sí	One-line summary.Restricciones: length 1 to 200
body	string	Sí	What happened and what is needed.Restricciones: length 1 to 20000
ticket_state	"Open" \| "Waiting" \| "Resolved" \| "Closed"	Sí	Request state.
membership_id	string (uuid)	Sí	Identifier of the member who asked.
assignee_membership_id	string (uuid) \| null	Sí	Identifier of the team member it is assigned to.
help_desk_response_due_at	string (date-time) \| null	Sí	When the first response is due.
first_responded_at	string (date-time) \| null	Sí	When the team 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",
      "ticket_number": "SUP-0001",
      "help_desk_team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "category": "Question",
      "severity": "Severity 3",
      "subject": "Tablet will not sign in",
      "body": "The dock tablet shows a blank screen.",
      "ticket_state": "Open",
      "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "assignee_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "help_desk_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/help-desk-requests" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

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

xos help-desk-requests list --all