List training course rows
Workforce module
GET/training-coursestrainingCourses.list
A short training course of lessons and quizzes with completion records and expiry, linked to a role, a certification and a gate criterion. Returns a cursor page of training course rows the caller may see. The default order is `title` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability knowledge.sop.read.
- OAuth scopes: knowledge.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| 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_]*)*$ |
| 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).Constraints: 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. |
Response 200: a page of 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. |
{
"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",
"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"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/training-courses" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.trainingCourses.listAll()) {
console.log(row);
}for row in xos.training_courses.list_all():
print(row)xos training-courses list --all