Skip to content

List training quiz question rows

Workforce module

GET/training-quiz-questionstrainingQuizQuestions.list

A question of a quiz lesson; its correct option is a training quiz key that learners never read. Returns a cursor page of training quiz question rows the caller may see. The default order is `created_at` 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

trainingQuizQuestions.list: Path and query parameters
FieldTypeRequiredDescription
limitLimitNoPage size. Default 50, maximum 200.Constraints: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort 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_]*)*$
filterFilterNoFilter 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 TrainingQuizQuestion

trainingQuizQuestions.list: TrainingQuizQuestion
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the training quiz question.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
training_lesson_idstring (uuid)YesIdentifier of the quiz lesson.
positionintegerYesOrder, from 1.Constraints: range 1 to any
promptstringYesQuestion text.Constraints: length 1 to 500
optionsarray of stringYesAnswer options.
{
  "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",
      "training_lesson_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "position": 1,
      "prompt": "What do you do before a lift?",
      "options": [
        "Inspect the sling",
        "Skip it"
      ]
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/training-quiz-questions" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.trainingQuizQuestions.listAll()) {
  console.log(row);
}
for row in xos.training_quiz_questions.list_all():
    print(row)
xos training-quiz-questions list --all