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

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

// 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": "<string>",
        "username": "<string>"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

after
string | null

Returns the elements in the list that come after the specified cursor.

before
string | null

Returns the elements in the list that come before the specified cursor.

first
integer | null

Returns the first n elements from the list.

Example:

42

last
integer | null

Returns the last n elements from the list.

Example:

42

course_id
string
required

The ID of the course

Example:

"cors_xxxxxxxxxxxxx"

keyword
string | null

Filter students by name - returns students whose names match the keyword

Response

A successful response

The connection type for CourseStudentType.

data
object[]
required

A list of nodes.

page_info
object
required

Information to aid in pagination.