1. Partner API v2
  2. Resources
  3. Training

Training

Curriculum, course catalog, and course assignments.
3 endpointsScope readTrainingAssignmentCourseCurriculumItem
GET/v2/users/{user_id}/training

List a user's course assignmentsLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of TrainingAssignment

Every course assigned to the user with its status, dates, and where the assignment came from.

Path parameters

user_idstringRequired

User id (the user's INFIMA id).

Query parametersall optional unless marked

statusstring

upcoming = start date in the future; open = started, not yet due; overdue = past due without completion; completed = passed.

One ofupcomingopenoverduecompleted
limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/users/b7e1c0d2-44aa-5f9e-8c33-1a2b3c4d5e6f/training" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of TrainingAssignment
dataarray of TrainingAssignment
Show item properties(10)
user_idstring
courseobject
Show properties(2)
idstring
titlestring
statusstring

upcoming = start date in the future; open = started, not yet due; overdue = past due without completion; completed = passed.

One ofupcomingopenoverduecompleted
sourcestring

Why the course was assigned. Open enum; new sources may be added.

One offrameworkadaptivemanualbehavioronboardingapi
framework_idstringNullable

Set when source is framework.

start_onstring (date)
due_onstring (date)
completed_atstring (date-time)Nullable
scoreintegerNullable

Quiz score percentage when the course has a quiz.

certificate_urlstringNullable

Signed link to the completion certificate, when one exists.

pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
GET/v2/courses

List the course catalogLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of Course

Courses available to your partner account, including your own custom courses.

Query parametersall optional unless marked

categorystring
qstring
limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/courses" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of Course
dataarray of Course
Show item properties(7)
idstring

The course slug.

titlestring
categorystring
descriptionstring
duration_minutesintegerNullable
languagesarray of string
Each one ofenesfr-ca
ownerstring

Whether it is a stock course or one your partner account created.

One ofinfimapartner
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
GET/v2/clients/{client_id}/training/curriculum

Get a client's curriculumLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of CurriculumItem

The courses scheduled for the client, grouped by audience, with completion percentage and where each course came from (framework, adaptive, manual).

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Query parametersall optional unless marked

statusstring

upcoming = start date in the future; open = started, not yet due; overdue = past due without completion; completed = passed.

One ofupcomingopenoverduecompleted
limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/training/curriculum" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of CurriculumItem
dataarray of CurriculumItem
Show item properties(10)
courseobject
Show properties(2)
idstring
titlestring
audienceobject

Who the course is scheduled for.

Show properties(3)
typestring
One ofallgroupcollectionusers
idstringNullable
namestringNullable
sourcestring

Why the course was assigned. Open enum; new sources may be added.

One offrameworkadaptivemanualbehavioronboardingapi
framework_idstringNullable
statusstring

upcoming = start date in the future; open = started, not yet due; overdue = past due without completion; completed = passed.

One ofupcomingopenoverduecompleted
start_onstring (date)
due_onstring (date)
assigned_countinteger
completed_countinteger
completion_ratenumber (float)
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
Coming in 2.x1 more Training operation is specified for a later 2.x release.See the roadmap