Get a training quiz key
Workforce module
GET/training-quiz-keys/{id}trainingQuizKeys.get
The correct option of a quiz question. Only course editors read it. Returns one training quiz key with its `ETag`. A training quiz key the caller may not see returns 404.
- Requires the capability knowledge.sop.publish.
- 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 quiz key. |
| 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: TrainingQuizKey
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the training quiz key. |
| 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. |
| training_quiz_question_id | string (uuid) | Yes | Identifier of the quiz question. |
| correct_option | integer | Yes | Correct option, from 1.Constraints: range 1 to any |
{
"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_quiz_question_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"correct_option": 1
}Code samples
curl -X GET "$XOS_BASE_URL/training-quiz-keys/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.trainingQuizKeys.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.training_quiz_keys.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos training-quiz-keys get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f