List training course rows

Módulo Workforce

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.

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

trainingCourses.list: 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 TrainingCourse

trainingCourses.list: TrainingCourse
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the training course.
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.
title	string	Sí	Course title.Restricciones: length 1 to 200
summary	string \| null	Sí	What the course teaches.Restricciones: length 1 to 2000
role_code	string \| null	Sí	Canon role trained for.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
certification_id	string (uuid) \| null	Sí	Identifier of the org certification a pass qualifies for.
gate_criterion_id	string \| null	Sí	Canon gate criterion the course helps satisfy.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
validity_days	integer \| null	Sí	Days a pass stays current.Restricciones: range 1 to any
pass_percent	integer	Sí	Quiz score needed to pass, in percent.Restricciones: range 1 to any
estimated_minutes	integer \| null	Sí	Expected time.Restricciones: range 1 to any
course_state	"Draft" \| "Published" \| "Retired"	Sí	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
}

Ejemplos de código

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