List handbook article rows
Módulo Workforce
GET/handbook-articleshandbookArticles.list
A handbook or SOP article: versioned on publish, optionally a mandatory read acknowledged per version. Returns a cursor page of handbook article rows the caller may see. The default order is `title` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad knowledge.sop.read.
- Alcances de OAuth: knowledge.
- 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
| 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 HandbookArticle
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the handbook article. |
| 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. |
| handbook_section_id | string (uuid) | null | Sí | Identifier of the section. |
| title | string | Sí | Title.Restricciones: length 1 to 200 |
| body | string | Sí | Working text; members read the published version.Restricciones: length 1 to 20000 |
| is_mandatory | boolean | Sí | Whether every member must acknowledge the current version. |
| article_state | "Draft" | "Published" | "Archived" | Sí | Article state. |
| published_version | integer | Sí | Latest published version.Restricciones: range 0 to any |
| published_at | string (date-time) | null | Sí | When the latest version was published. |
{
"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",
"handbook_section_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"title": "Hearing protection",
"body": "Wear hearing protection near the stacks.",
"is_mandatory": true,
"article_state": "Draft",
"published_version": 1,
"published_at": "2026-10-08T14:30:00Z"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/handbook-articles" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.handbookArticles.listAll()) {
console.log(row);
}for row in xos.handbook_articles.list_all():
print(row)xos handbook-articles list --all