List 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": "<string>",
      "order": 42,
      "lesson_type": "text",
      "visibility": "visible",
      "content": "<string>",
      "days_from_course_start_until_unlock": 42,
      "embed_type": "youtube",
      "embed_id": "<string>",
      "created_at": "2023-12-01T05:00:00.401Z",
      "thumbnail": {
        "url": "<string>"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

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": "<string>",
      "order": 42,
      "lesson_type": "text",
      "visibility": "visible",
      "content": "<string>",
      "days_from_course_start_until_unlock": 42,
      "embed_type": "youtube",
      "embed_id": "<string>",
      "created_at": "2023-12-01T05:00:00.401Z",
      "thumbnail": {
        "url": "<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 | 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.

Show child attributes

data.id

string

required

The ID of the lesson

Example:

"lesn_xxxxxxxxxxxxx"

data.title

string

required

The title of the lesson

data.order

integer

required

The order of the lesson within its chapter

Example:

42

data.lesson_type

enum<string>

required

The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)

Available options:

text,

video,

pdf,

multi,

quiz,

knowledge_check

data.visibility

enum<string>

required

The visibility of the lesson. Determines how / whether this lesson is visible to users.

Available options:

visible,

hidden

data.content

string | null

required

The content of the lesson

data.days_from_course_start_until_unlock

integer | null

required

Number of days from course start until the lesson is unlocked

Example:

42

data.embed_type

enum<string> | null

required

Type of embed for video lessons (youtube or loom)

Available options:

youtube,

loom

data.embed_id

string | null

required

ID for the embed (YouTube video ID or Loom share ID)

data.created_at

string<date-time>

required

The timestamp of when the lesson was created

Example:

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

data.thumbnail

object

required

The thumbnail for the lesson

Show child attributes

data.thumbnail.url

string | null

required

This is the URL you use to render optimized attachments on the client. This should be used for apps.

page_info

object

required

Information to aid in pagination.

Show child attributes

page_info.end_cursor

string | null

required

When paginating forwards, the cursor to continue.

page_info.start_cursor

string | null

required

When paginating backwards, the cursor to continue.

page_info.has_next_page

boolean

required

When paginating forwards, are there more items?

page_info.has_previous_page

boolean

required

When paginating backwards, are there more items?

Delete course chapter Create course lesson

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

List course lessons

Authorizations

Query Parameters

Response