Skip to main content
GET
/
course_lessons
JavaScript
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 courseLessonListResponse of client.courseLessons.list()) {
  console.log(courseLessonListResponse.id);
}
{
  "data": [
    {
      "id": "lesn_xxxxxxxxxxxxx",
      "title": "Understanding Candlestick Patterns",
      "order": 42,
      "lesson_type": "text",
      "visibility": "visible",
      "content": "In this lesson, we will cover the basics of technical analysis...",
      "days_from_course_start_until_unlock": 42,
      "embed_type": "youtube",
      "embed_id": "dQw4w9WgXcQ",
      "created_at": "2023-12-01T05:00:00.401Z",
      "thumbnail": {
        "url": "https://media.whop.com/abc123/optimized.jpg"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

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 ***************************

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 unique identifier of the course to return all lessons across all chapters.

Example:

"cors_xxxxxxxxxxxxx"

​
chapter_id
string | null

The unique identifier of a chapter to return only its lessons.

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.