Training
Retrieve series and module content, manage invitations and reviewers, complete modules, and migrate mission learner data.
The Training APIs return your organization’s training content and manage who is assigned to it. Use them to list series and modules, read structured learning object data, invite or remove users, assign reviewers, mark modules complete, and migrate mission learner data from one user to another.
Key capabilities
Section titled “Key capabilities”- Series and module listing: Retrieve a complete list of all series and the modules contained within them.
- Content details: Access structured data for specific content assets, such as files, assessments, and quizzes, including media URLs and correct-answer flags. For transcript access, see Learning object limitations.
- Content assignment: Enroll users in series and modules, or revoke their access.
- Reviewer management: Assign reviewers to users and track related process statuses.
- Single and bulk completion: Mark a specific module as complete for an individual user or apply updates to a large group of learners in a single request.
- Backdated progress: Record completions with past timestamps to accurately reflect training history. This works in tandem with backdated invitations to keep data consistent during migration.
Prerequisites and shared context
Section titled “Prerequisites and shared context”To work with these APIs, you must be familiar with the following platform standards:
- Authentication: How to generate and use your Bearer token.
- Base URLs: Determining the correct regional endpoint for your account.
- Rate limits: Understanding platform quotas and retry logic.
- Conventions: Standard JSON data formats and HTTP status codes.
For more information, see Authentication and setup.
Most Training endpoints use the standard REST base URL. Complete a mission or AI Roleplay and Migrate mission learner data use the API3 base URL instead.
In this category
Section titled “In this category”- Series: list series and manage series level invitations.
- List all series: returns every series created on your learning site.
- Invite a user to series and modules: invites one user to one or more series or specific modules within a series.
- Invite users to a series: invites up to 40 users to a series, with optional backdated invite timestamps.
- Remove users from a series or module: removes up to 500 users from a series or a module.
- Modules: read module content and manage module invitations, reviewers, and completions.
- List all modules in a series: returns the modules in a series.
- Get module details: returns the details of a single module.
- Get module learning object details: returns the learning contents of a module.
- Learning object content types: the content types the learning object response returns.
- Invite users to a module: invites up to 500 users to a module, with optional module relevance and backdated invite timestamps.
- Assign reviewers to users: assigns and replaces reviewers in bulk for mission and coaching session modules.
- Check process status: returns the status of a reviewer assignment process.
- Complete modules for multiple users: marks a module complete for up to 50 users.
- Complete a module for a user: marks a module complete for a single user.
- Complete a mission or AI Roleplay: marks a mission or AI Roleplay complete for a learner.
- Migrate mission learner data: transfers mission progress from one user ID to another.