Get a std document
Canon module
GET/canon/std/document-library/{record_id}canonStdDocumentLibrary.get
A document and asset library entry. Standard Library row, copied into each new org as editable org data. Returns one std document with its `ETag`. A std document the caller may not see returns 404.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| record_id | StdCode | Yes | Natural code of a Standard Library row (Section 2.1).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| fields | Fields | No | Sparse 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: StdDocument
| Field | Type | Required | Description |
|---|---|---|---|
| record_id | StdCode | Yes | Natural code of a Standard Library row (Section 2.1).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| document_name | string | null | Yes | Document name.Constraints: length 1 to 500 |
| document_type | string | null | Yes | Document type.Constraints: length 1 to 200 |
| reference_id | string | null | Yes | Reference identifier.Constraints: length 1 to 200 |
| file_format | string | null | Yes | File format.Constraints: length 1 to 100 |
| version | string | null | Yes | Version.Constraints: length 1 to 100 |
| issue_date | string (date) | null | Yes | Issue date. |
| expiration_date | string (date) | null | Yes | Expiration date. |
| department | string | null | Yes | Department as the sheet names it.Constraints: length 1 to 200 |
| category | string | null | Yes | Category code or name as the sheet gives it.Constraints: length 1 to 200 |
| sub_category | string | null | Yes | Sub-category as the sheet names it.Constraints: length 1 to 200 |
| status | string | null | Yes | Row status in the sheet.Constraints: length 1 to 200 |
| notes | string | null | Yes | Notes in the sheet.Constraints: length 1 to 20000 |
| organization | string | null | Yes | Organization as the sheet names it.Constraints: length 1 to 200 |
| project | string | null | Yes | Project as the sheet names it.Constraints: length 1 to 200 |
| file_size | string | null | Yes | File size as the sheet gives it.Constraints: length 1 to 100 |
| storage_url | string | null | Yes | Where the file is stored, as the sheet gives it.Constraints: length 1 to 2000 |
{
"record_id": "SOP-001",
"document_name": "Venue Load-In Guide",
"document_type": "Guide",
"reference_id": "DOC-004",
"file_format": "PDF",
"version": "v2.0",
"issue_date": "2026-10-08",
"expiration_date": "2026-10-08",
"department": "5000 Production",
"category": "5000.05.02",
"sub_category": "Overhead Rigging",
"status": "Active",
"notes": "Primary life safety and incident response",
"organization": "GHXSTSHIP",
"project": "CSMIA26",
"file_size": "48.5 MB",
"storage_url": "https://files.example/doc-001.pdf"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/std/document-library/SOP-001" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonStdDocumentLibrary.get("SOP-001");response = xos.canon_std_document_library.get("SOP-001")xos canon-std-document-library get SOP-001