Skip to content

Get a handbook section

Workforce module

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.

  • Requires the capability knowledge.sop.read.
  • OAuth scopes: knowledge.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

handbookSections.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the handbook section.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: HandbookSection

handbookSections.get: HandbookSection
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the handbook section.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
namestringYesSection name.Constraints: length 1 to 120
positionintegerYesOrder.Constraints: 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
}

Code samples

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