Skip to content

Properties

idstring
required·

The unique identifier for the course enrollment record

assigned_atstring · date-time

The date and time the course was assigned to the user, when available

assigned_byobject

The assigner of this course to the user, when available

idstring

The unique identifier for a user

namestring

The name of the user

attempt_numberinteger

The latest attempt number, when the LMS supports retakes

attempts_countinteger

Total attempts count, when available

completed_atstring · date-time

The date and time the user completed the course, when available

courseobject

The course associated with this record

idstring

The unique identifier for the course

titlestring

The title of the course

created_atstring · date-time

The date and time the enrollment record was created

custom_fieldsobject

Provider or customer specific fields mapped into a flexible key-value object

due_atstring · date-time

The due date for course completion, when available

enrolled_atstring · date-time

The date and time the user enrolled or registered, when available

is_mandatoryboolean

Whether this enrollment is part of a mandatory assignment, when available

last_activity_atstring · date-time

The date and time of the last recorded activity for this enrollment, when available

progress_percentnumber

Progress percentage from 0 to 100, when available

remote_dataRecord<string, any>

Raw data returned from the remote API call.

scorenumber

The latest or final score, when available

started_atstring · date-time

The date and time the user started the course, when available

statusstring

The lifecycle status for the user in this course

Possible values:
assignedenrolledin_progresscompletedpassedfailedwithdrawnexpiredoverdueunknown
time_spent_secondsinteger

Total time spent in seconds, when available

updated_atstring · date-time

The date and time the enrollment record was last updated

urlsobject[]

The URLs of the course-enrollments

typestring

The type of URL

urlstring

The URL

userobject

The learner associated with this record

emailsobject[]

The emails of the user

3 properties
emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

idstring

The unique identifier for a user

namestring

The name of the user