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

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

// Automatically fetches more pages as needed.
for await (const courseLessonListResponse of client.courseLessons.list()) {
  console.log(courseLessonListResponse.id);
}
{
  "data": [
    {
      "id": "lesn_xxxxxxxxxxxxx",
      "title": "<string>",
      "order": 42,
      "lesson_type": "text",
      "visibility": "visible",
      "content": "<string>",
      "days_from_course_start_until_unlock": 42
    }
  ],
  "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 | null

The ID of the course (returns all lessons across all chapters)

Example:

"cors_xxxxxxxxxxxxx"

chapter_id
string | null

The ID of the chapter (returns lessons only for this chapter)

Example:

"chap_xxxxxxxxxxxxx"

Response

A successful response

The connection type for Lesson.

data
object[]
required

A list of nodes.

page_info
object
required

Information to aid in pagination.