Appearance

CourseEnrollments Object ​


id
string
REQUIRED · 

The unique identifier for the course enrollment record

user
object

The learner associated with this record

id
string

The unique identifier for a user

name
string

The name of the user

emails
object[]

The emails of the user

email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

course
object

The course associated with this record

id
string

The unique identifier for the course

title
string

The title of the course

status
string

The lifecycle status for the user in this course

All possible enum values:
  • assigned
  • enrolled
  • in_progress
  • completed
  • passed
  • failed
  • withdrawn
  • expired
  • overdue
  • unknown
assigned_at
string · date-time

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

due_at
string · date-time

The due date for course completion, when available

enrolled_at
string · date-time

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

started_at
string · date-time

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

last_activity_at
string · date-time

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

completed_at
string · date-time

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

progress_percent
number

Progress percentage from 0 to 100, when available

time_spent_seconds
integer

Total time spent in seconds, when available

score
number

The latest or final score, when available

is_mandatory
boolean

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

assigned_by
object

The assigner of this course to the user, when available

id
string

The unique identifier for a user

name
string

The name of the user

attempt_number
integer

The latest attempt number, when the LMS supports retakes

attempts_count
integer

Total attempts count, when available

urls
object[]

The URLs of the course-enrollments

url
string

The URL

type
string

The type of URL

created_at
string · date-time

The date and time the enrollment record was created

updated_at
string · date-time

The date and time the enrollment record was last updated

custom_fields
object

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

remote_data
object

Raw data returned from the remote API call.