List role rows

Módulo Settings

GET/rolesroles.list

A role: a platform role or an org custom role built from the capability set. Returns a cursor page of role rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad org.members.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

roles.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 Role

roles.list: Role
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the role.
org_id	string (uuid) \| null	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.
name	string \| null	Sí	Role name.Restricciones: length 1 to 300
description	string \| null	Sí	What the role is for.Restricciones: length 1 to 20000
code	string	Sí	Role code. System role labels come from the i18n catalogs keyed by it; custom role codes never reuse a system code.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
band	integer	Sí	Band in Section 8 order, 1 Owner to 7 Viewer. Custom roles take 2 to 7, and a person assigns only roles at or below their own band.Restricciones: range 1 to any

{
  "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",
      "name": "Finance Approver",
      "description": "Approves purchase orders up to the spend limit.",
      "code": "site_lead",
      "band": 4
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos roles list --all