import Whop from '@whop/sdk';
const client = new Whop({
apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const courseStudentListResponse of client.courseStudents.list({
course_id: 'cors_xxxxxxxxxxxxx',
})) {
console.log(courseStudentListResponse.id);
}{
"data": [
{
"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": "John Doe",
"username": "johndoe42"
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}Returns a paginated list of students enrolled in a course, with optional name filtering.
Required permissions:
courses:readcourse_analytics:readimport Whop from '@whop/sdk';
const client = new Whop({
apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const courseStudentListResponse of client.courseStudents.list({
course_id: 'cors_xxxxxxxxxxxxx',
})) {
console.log(courseStudentListResponse.id);
}{
"data": [
{
"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": "John Doe",
"username": "johndoe42"
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}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 ***************************
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
42
Returns the last n elements from the list.
42
The unique identifier of the course to list enrolled students for.
"cors_xxxxxxxxxxxxx"
A search term to filter students by name or username.
Was this page helpful?