List capability rows

Módulo Settings

GET/capabilitiescapabilities.list

A capability from `packages/schemas/capabilities.yaml`. Read-only. Returns a cursor page of capability rows the caller may see. The default order is `code` 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

capabilities.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 Capability

capabilities.list: Capability
Campo	Tipo	Obligatorio	Descripción
code	string	Sí	Capability verb.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
module_code	string	Sí	Capability group; OAuth scopes map one to one to groups.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
capability_class	"read" \| "write" \| "approve" \| "manage" \| "export"	Sí	Kind of act the capability authorizes.
description	string	Sí	What the capability allows, for documentation and the roles page.Restricciones: length 1 to 2000
sort_order	integer	Sí	Registry order, the default sort.Restricciones: range 0 to any

{
  "data": [
    {
      "code": "finance.po.approve",
      "module_code": "finance",
      "capability_class": "read",
      "description": "Approve purchase orders within spend authority.",
      "sort_order": 1
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos capabilities list --all