Skip to main content
GET
/
course_students
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: 'My API Key',
});

const courseStudent = await client.courseStudents.retrieve('id');

console.log(courseStudent.id);
{
  "id": "<string>",
  "completed_lessons_count": 42,
  "completion_rate": 6.9,
  "total_lessons_count": 42,
  "first_interaction_at": "2023-12-01T05:00:00.401Z",
  "last_interaction_at": "2023-12-01T05:00:00.401Z",
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "<string>",
    "username": "<string>"
  },
  "course": {
    "id": "cors_xxxxxxxxxxxxx",
    "title": "<string>",
    "experience": {
      "id": "exp_xxxxxxxxxxxxxx"
    }
  }
}

Authorizations

Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Path Parameters

id
string
required

The ID of the course student interaction

Response

A successful response

A course student (enrollment of a student in a course)

id
string
required

The ID of the course student. Looks like crsi_XXX

completed_lessons_count
integer
required

The number of lessons the student has completed

Example:

42

completion_rate
number
required

The percentage of lessons completed (0-100)

Example:

6.9

total_lessons_count
integer
required

The total number of lessons the student has access to

Example:

42

first_interaction_at
string<date-time>
required

When the student first interacted with the course

Example:

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

last_interaction_at
string<date-time>
required

When the student last interacted with the course

Example:

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

user
object
required

The user who is enrolled in the course

course
object
required

The course the student is enrolled in