Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

id
string
required

The unique identifier of the course student record to retrieve.

Response

A successful response

An enrollment record for a student in a course, including progress and completion metrics.

completed_lessons_count
integer
required

The total number of lessons this student has marked as completed in the course.

Example:

42

completion_rate
number
required

The percentage of available lessons the student has completed, as a value from 0 to 100 rounded to two decimal places.

Example:

6.9

course
object
required

The course this student is enrolled in.

first_interaction_at
string<date-time>
required

The timestamp when the student first interacted with this course, as a Unix timestamp.

Example:

"2023-12-01T05:00:00.401Z"

id
string
required

The unique identifier for the course student type.

last_interaction_at
string<date-time>
required

The timestamp when the student most recently interacted with this course, as a Unix timestamp.

Example:

"2023-12-01T05:00:00.401Z"

total_lessons_count
integer
required

The total number of visible lessons available to this student in the course.

Example:

42

user
object
required

The user profile of the enrolled student.