Get a handbook section

Módulo Workforce

GET/handbook-sections/{id}handbookSections.get

A chapter of the org handbook. Returns one handbook section with its `ETag`. A handbook section the caller may not see returns 404.

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

Parámetros de ruta y de consulta

handbookSections.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the handbook section.
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: HandbookSection

handbookSections.get: HandbookSection
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the handbook section.
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.
name	string	Sí	Section name.Restricciones: length 1 to 120
position	integer	Sí	Order.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": "Site rules",
  "position": 1
}

Ejemplos de código

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

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

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

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