Retrieve course

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const course = await client.courses.retrieve('cors_xxxxxxxxxxxxx');

console.log(course.id);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/courses/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/courses/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/courses/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "certificate_after_completion_enabled": true,
  "chapters": [
    {
      "id": "chap_xxxxxxxxxxxxx",
      "lessons": [
        {
          "id": "lesn_xxxxxxxxxxxxx",
          "lesson_type": "text",
          "order": 42,
          "thumbnail": {
            "url": "https://media.whop.com/abc123/optimized.jpg"
          },
          "title": "Understanding Candlestick Patterns",
          "video_asset": {
            "duration_seconds": 42,
            "signed_playback_id": "<string>",
            "signed_thumbnail_playback_token": "<string>"
          }
        }
      ],
      "order": 42,
      "title": "Getting Started"
    }
  ],
  "chapters_count": 42,
  "completed_lessons_count": 42,
  "cover_image": "https://assets.whop.com/images/course-cover.jpg",
  "created_at": "2023-12-01T05:00:00.401Z",
  "description": "Learn advanced trading strategies from industry experts.",
  "id": "cors_xxxxxxxxxxxxx",
  "language": "en",
  "latest_lesson_created_at": "2023-12-01T05:00:00.401Z",
  "lesson_unlock_days": [
    42
  ],
  "order": "123.45",
  "require_completing_lessons_in_order": true,
  "resume_lesson": {
    "id": "lesn_xxxxxxxxxxxxx"
  },
  "started_at": "2023-12-01T05:00:00.401Z",
  "tagline": "Master the fundamentals in 30 days",
  "thumbnail": {
    "content_type": "image/jpeg",
    "filename": "document.pdf",
    "id": "<string>",
    "optimized_url": "https://media.whop.com/abc123/optimized.jpg",
    "source_url": "https://media.whop.com/abc123/original.jpg"
  },
  "title": "Introduction to Technical Analysis",
  "total_duration_seconds": 42,
  "total_lessons_count": 42,
  "updated_at": "2023-12-01T05:00:00.401Z",
  "visibility": "visible"
}

{
  "error": {
    "code": "parameter_missing",
    "message": "Missing required parameter: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "Invalid or missing API key",
    "type": "unauthorized"
  }
}

{
  "error": {
    "message": "You do not have permission to access this resource",
    "type": "forbidden"
  }
}

{
  "error": {
    "message": "Resource not found",
    "type": "not_found"
  }
}

{
  "error": null
}

{
  "error": null
}

{
  "error": {
    "message": "An unexpected error occurred",
    "type": "internal_server_error"
  }
}

GET

courses

{id}

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const course = await client.courses.retrieve('cors_xxxxxxxxxxxxx');

console.log(course.id);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/courses/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/courses/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/courses/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "certificate_after_completion_enabled": true,
  "chapters": [
    {
      "id": "chap_xxxxxxxxxxxxx",
      "lessons": [
        {
          "id": "lesn_xxxxxxxxxxxxx",
          "lesson_type": "text",
          "order": 42,
          "thumbnail": {
            "url": "https://media.whop.com/abc123/optimized.jpg"
          },
          "title": "Understanding Candlestick Patterns",
          "video_asset": {
            "duration_seconds": 42,
            "signed_playback_id": "<string>",
            "signed_thumbnail_playback_token": "<string>"
          }
        }
      ],
      "order": 42,
      "title": "Getting Started"
    }
  ],
  "chapters_count": 42,
  "completed_lessons_count": 42,
  "cover_image": "https://assets.whop.com/images/course-cover.jpg",
  "created_at": "2023-12-01T05:00:00.401Z",
  "description": "Learn advanced trading strategies from industry experts.",
  "id": "cors_xxxxxxxxxxxxx",
  "language": "en",
  "latest_lesson_created_at": "2023-12-01T05:00:00.401Z",
  "lesson_unlock_days": [
    42
  ],
  "order": "123.45",
  "require_completing_lessons_in_order": true,
  "resume_lesson": {
    "id": "lesn_xxxxxxxxxxxxx"
  },
  "started_at": "2023-12-01T05:00:00.401Z",
  "tagline": "Master the fundamentals in 30 days",
  "thumbnail": {
    "content_type": "image/jpeg",
    "filename": "document.pdf",
    "id": "<string>",
    "optimized_url": "https://media.whop.com/abc123/optimized.jpg",
    "source_url": "https://media.whop.com/abc123/original.jpg"
  },
  "title": "Introduction to Technical Analysis",
  "total_duration_seconds": 42,
  "total_lessons_count": 42,
  "updated_at": "2023-12-01T05:00:00.401Z",
  "visibility": "visible"
}

{
  "error": {
    "code": "parameter_missing",
    "message": "Missing required parameter: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "Invalid or missing API key",
    "type": "unauthorized"
  }
}

{
  "error": {
    "message": "You do not have permission to access this resource",
    "type": "forbidden"
  }
}

{
  "error": {
    "message": "Resource not found",
    "type": "not_found"
  }
}

{
  "error": null
}

{
  "error": null
}

{
  "error": {
    "message": "An unexpected error occurred",
    "type": "internal_server_error"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Path Parameters

string

required

The unique identifier of the course to retrieve.

Example:

"cors_xxxxxxxxxxxxx"

Response

A successful response

A structured learning module containing chapters and lessons, belonging to an experience.

certificate_after_completion_enabled

boolean | null

required

Whether students receive a PDF certificate after completing all lessons in this course. Null if the setting has not been configured.

chapters

object[]

required

An ordered list of all chapters in this course, sorted by their display position.

Show child attributes

chapters_count

integer

required

The total number of chapters in this course, including chapters whose lessons are all hidden from the current user.

Example:

42

completed_lessons_count

integer

required

The number of lessons in this course that the current user has marked as completed. Zero when the request is not made on behalf of a user.

Example:

42

cover_image

string | null

required

The URL of the course cover image shown on preview cards. Null if no cover image has been uploaded.

Example:

"https://assets.whop.com/images/course-cover.jpg"

created_at

string<date-time>

required

The datetime the course was created.

Example:

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

description

string | null

required

A brief summary of the course content and objectives. Null if no description has been set.

Example:

"Learn advanced trading strategies from industry experts."

string

required

The unique identifier for the course.

Example:

"cors_xxxxxxxxxxxxx"

language

enum<string>

required

The spoken language of the video content, used to generate accurate closed captions. One of: en, es, it, pt, de, fr, pl, ru, nl, ca, tr, sv, uk, no, fi, sk, el, cs, hr, da, ro, bg.

Available options:

en,

es,

it,

pt,

de,

fr,

pl,

ru,

nl,

ca,

tr,

sv,

uk,

no,

fi,

sk,

el,

cs,

hr,

da,

ro,

bg

latest_lesson_created_at

string<date-time> | null

required

The creation timestamp of the most recently added lesson visible to the current user. Null if the course has no lessons.

Example:

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

lesson_unlock_days

integer[]

required

The distinct drip schedules, in days after the course start, of lessons visible to the current user. Combine with startedAt to work out which have unlocked. Empty when the user has not started the course or no lesson is on a schedule.

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

order

string

required

The sort position of this course within its parent experience, as a decimal for flexible ordering.

Example:

"123.45"

require_completing_lessons_in_order

boolean

required

Whether students must complete each lesson sequentially before advancing to the next one.

resume_lesson

object | null

required

The lesson the current user should continue from: their first incomplete lesson, or the first lesson when they have finished the course, have not started it, or can edit it. Null if the course has no lessons.

Show child attributes

started_at

string<date-time> | null

required

The earliest time the current user is known to have started this course. Null if they have not started it. Drip unlock schedules are measured from this point.

Example:

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

tagline

string | null

required

A short marketing tagline displayed beneath the course title. Null if no tagline has been set.

Example:

"Master the fundamentals in 30 days"

thumbnail

object | null

required

The thumbnail image displayed on course cards and previews. Null if no thumbnail has been uploaded.

Show child attributes

title

string | null

required

The display name of the course shown to students. Null if no title has been set.

Example:

"Introduction to Technical Analysis"

total_duration_seconds

integer

required

The combined duration in seconds of every hosted video across the lessons visible to the current user.

Example:

42

total_lessons_count

integer

required

The number of lessons in this course visible to the current user.

Example:

42

updated_at

string<date-time>

required

The datetime the course was last updated.

Example:

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

visibility

enum<string>

required

The visibility setting that controls whether this course appears to students. One of: visible, hidden.

Available options:

visible,

hidden

⌘I

Introduction

Ledger stats

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats

Authorizations

Path Parameters

Response