Get a training course
Workforce module
GET/training-courses/{id}trainingCourses.get
A short training course of lessons and quizzes with completion records and expiry, linked to a role, a certification and a gate criterion. Returns one training course with its `ETag`. A training course 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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the training course. |
| 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: TrainingCourse
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the training course. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| title | string | Yes | Course title.Constraints: length 1 to 200 |
| summary | string | null | Yes | What the course teaches.Constraints: length 1 to 2000 |
| role_code | string | null | Yes | Canon role trained for.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| certification_id | string (uuid) | null | Yes | Identifier of the org certification a pass qualifies for. |
| gate_criterion_id | string | null | Yes | Canon gate criterion the course helps satisfy.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| validity_days | integer | null | Yes | Days a pass stays current.Constraints: range 1 to any |
| pass_percent | integer | Yes | Quiz score needed to pass, in percent.Constraints: range 1 to any |
| estimated_minutes | integer | null | Yes | Expected time.Constraints: range 1 to any |
| course_state | "Draft" | "Published" | "Retired" | Yes | Course state. |
{
"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": "Rigging basics",
"summary": "Slings and shackles.",
"role_code": "5000.01.01",
"certification_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"gate_criterion_id": "G3.CREW_TRAINED",
"validity_days": 365,
"pass_percent": 80,
"estimated_minutes": 20,
"course_state": "Draft"
}Code samples
curl -X GET "$XOS_BASE_URL/training-courses/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.trainingCourses.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.training_courses.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos training-courses get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f