Get a role

Módulo Settings

GET/roles/{id}roles.get

A role: a platform role or an org custom role built from the capability set. Returns one role with its `ETag`. A role the caller may not see returns 404.

Requiere la capacidad org.members.read.
Alcances de OAuth: org.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

roles.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the role.
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_])*$

Respuesta 200: Role

roles.get: 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

{
  "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
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/roles/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.roles.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.roles.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos roles get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f