List courses

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 courseListResponse of client.courses.list()) {
  console.log(courseListResponse.id);
}

{
  "data": [
    {
      "id": "cors_xxxxxxxxxxxxx",
      "title": "<string>",
      "tagline": "<string>",
      "cover_image": "<string>",
      "thumbnail": {
        "id": "<string>",
        "filename": "<string>",
        "content_type": "<string>",
        "optimized_url": "<string>",
        "source_url": "<string>"
      },
      "description": "<string>",
      "language": "en",
      "certificate_after_completion_enabled": true,
      "require_completing_lessons_in_order": true,
      "order": "123.45",
      "visibility": "visible",
      "created_at": "2023-12-01T05:00:00.401Z",
      "updated_at": "2023-12-01T05:00:00.401Z"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

GET

courses

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 courseListResponse of client.courses.list()) {
  console.log(courseListResponse.id);
}

{
  "data": [
    {
      "id": "cors_xxxxxxxxxxxxx",
      "title": "<string>",
      "tagline": "<string>",
      "cover_image": "<string>",
      "thumbnail": {
        "id": "<string>",
        "filename": "<string>",
        "content_type": "<string>",
        "optimized_url": "<string>",
        "source_url": "<string>"
      },
      "description": "<string>",
      "language": "en",
      "certificate_after_completion_enabled": true,
      "require_completing_lessons_in_order": true,
      "order": "123.45",
      "visibility": "visible",
      "created_at": "2023-12-01T05:00:00.401Z",
      "updated_at": "2023-12-01T05:00:00.401Z"
    }
  ],
  "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

experience_id

string | null

The ID of the experience

Example:

"exp_xxxxxxxxxxxxxx"

company_id

string | null

The ID of the company

Example:

"biz_xxxxxxxxxxxxxx"

Response

A successful response

The connection type for Course.

data

object[]

required

A list of nodes.

Show child attributes

data.id

string

required

The ID of the course. Looks like cors_XXX

Example:

"cors_xxxxxxxxxxxxx"

data.title

string | null

required

The title of the course

data.tagline

string | null

required

A short tagline for the course. It is displayed under the course title in the UI

data.cover_image

string | null

required

The URL of the course's cover image, which is shown in course preview cards

data.thumbnail

object

required

The thumbnail for the course

Show child attributes

data.thumbnail.id

string

required

The ID of the attachment

data.thumbnail.filename

string | null

required

The name of the file

data.thumbnail.content_type

string | null

required

The attachment's content type (e.g., image/jpg, video/mp4)

data.thumbnail.optimized_url

string | null

required

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

data.thumbnail.source_url

string | null

required

The original URL of the attachment, such as a direct link to S3. This should never be displayed on the client and always passed to an Imgproxy transformer.

data.description

string | null

required

A short description of the course

data.language

enum<string>

required

The language spoken in the video content of the course, used to generate closed captions in the right language

Available options:

en,

es,

it,

pt,

de,

fr,

pl,

ru,

nl,

ca,

tr,

sv,

uk,

no,

fi,

sk,

el,

cs,

hr,

da,

ro,

bg

data.certificate_after_completion_enabled

boolean | null

required

Whether the course will award its students a PDF certificate after completing all lessons

data.require_completing_lessons_in_order

boolean

required

Whether the course requires students to complete the previous lesson before moving on to the next one

data.order

string

required

The order of the course within its experience

Example:

"123.45"

data.visibility

enum<string>

required

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

Available options:

visible,

hidden

data.created_at

string<date-time>

required

The timestamp of when the course was created

Example:

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

data.updated_at

string<date-time>

required

The timestamp of when the course was last updated

Example:

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

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?

Create notification Create course

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Authorizations

Query Parameters

Response