Get a SOP
Módulo Knowledge
GET/sops/{id}sops.get
A standard operating procedure that members acknowledge. Returns one SOP with its `ETag`. A SOP 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
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the sop. |
| 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: Sop
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the sop. |
| 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í | 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. |
| title | string | Sí | SOP title.Restricciones: length 1 to 300 |
| body | string | Sí | Procedure text.Restricciones: length 1 to 20000 |
| code | string | Sí | SOP code, SOP- and three to five digits.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| version | integer | Sí | Version number, raised on each publish.Restricciones: range 1 to any |
| published_at | string (date-time) | null | Sí | When the current version was published; null while draft. |
{
"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",
"title": "Working at Height",
"body": "Confirm the dock slot, then stage by department.",
"code": "SOP-001",
"version": 1,
"published_at": "2026-10-08T14:30:00Z"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/sops/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.sops.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.sops.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos sops get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f