Sign in
latestOpenAPI 3.1.02026-08-0817082.3 KB

cac8702ed2aa

Learner Training Modules

Get a learner training module by id

Get a training module.

get/v1/learner-training-modules/{id}

Path parameters

idstring required

The unique identifier of a learner training module.

Example:ltm456ghi9

Response

Success

idstring required

The unique identifier of a learner training module.

trainingCampaignIdstring required

The unique identifier of a training campaign.

learnerIdstring required

The unique identifier of a learner.

moduleNamestring required

The name of the training module.

lengthInMinutesnumber required

The training length of the module in minutes.

assignedAtstring date-time required

The date and time the learner was assigned the training module.

status'YEARLY_TRAINING_REMOVED' | 'COURSE_UNENROLLED' | 'MIGRATION_COMPANY_UNENROLLED' | 'ADMIN_ARCHIVED' | 'WITHIN_DEADLINE' | 'INCOMPLETE' | 'USER_COMPLETED' | 'ADMIN_COMPLETED' | 'CLASSROOM_COMPLETED' | 'ASSESSMENT_SKIPPED' | 'SYSTEM_REMOVED' | 'ADMIN_REMOVED' | 'MIGRATED' required

The status of the learner training module.

Active statuses (learner can still interact and complete training):

  • WITHIN_DEADLINE: Assigned but not yet completed, still within the deadline
  • INCOMPLETE: Assigned but not completed, the deadline has passed

Completed statuses:

  • USER_COMPLETED: Learner completed the module themselves
  • ADMIN_COMPLETED: Administrator marked the module as completed
  • CLASSROOM_COMPLETED: Completed in a classroom facilitated training
  • ASSESSMENT_SKIPPED: Learner passed an assessment, and skipped this module

Removed statuses:

  • ADMIN_REMOVED: Administrator removed the module
  • ADMIN_ARCHIVED: Archived by administrator when training campaign was cancelled or archived
  • SYSTEM_REMOVED: System automatically removed the module due to a change in population, learner status, or learner profile
  • YEARLY_TRAINING_REMOVED: Incomplete module that was removed when new yearly training was assigned
  • COURSE_UNENROLLED: Company unenrolled from the course
  • MIGRATION_COMPANY_UNENROLLED: Status changed during data migration
  • MIGRATED: Status changed during data migration
statusUpdatedAtstring date-time required

The instant of the latest status change of the training module.

Example response

{
  "id": "ltm456ghi9",
  "trainingCampaignId": "tc456xyz78",
  "learnerId": "abc123def4",
  "moduleName": "Foundations",
  "lengthInMinutes": 45,
  "assignedAt": "2025-05-01T00:00:00Z",
  "status": "WITHIN_DEADLINE",
  "statusUpdatedAt": "2025-06-10T21:39:59Z"
}