Skip to content

Get a training completion

Workforce module

GET/training-completions/{id}trainingCompletions.get

A training attempt with its quiz score; a pass carries a certificate number and expiry. Returns one training completion with its `ETag`. A training completion 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

trainingCompletions.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the training completion.
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_]*)*$

Response 200: TrainingCompletion

trainingCompletions.get: TrainingCompletion
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the training completion.
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_course_idstring (uuid)YesIdentifier of the course.
membership_idstring (uuid)YesIdentifier of the learner.
score_percentinteger | nullYesQuiz score in percent.Constraints: range 0 to any
passedbooleanYesWhether the attempt passed.
completed_atstring (date-time)YesWhen the attempt finished.
expires_atstring (date-time) | nullYesWhen the pass stops being current.
certificate_numberstring | nullYesCompletion certificate number.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
certification_holder_idstring (uuid) | nullYesIdentifier of the certification record a verifier issued.
{
  "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_course_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "score_percent": 90,
  "passed": true,
  "completed_at": "2026-10-08T14:30:00Z",
  "expires_at": "2026-10-08T14:30:00Z",
  "certificate_number": "TRN-0001",
  "certification_holder_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X GET "$XOS_BASE_URL/training-completions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.trainingCompletions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.training_completions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos training-completions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f