Skip to main content
GET
JavaScript

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

Path Parameters

id
string
required

The unique identifier of the lesson to retrieve.

Example:

"lesn_xxxxxxxxxxxxx"

Response

A successful response

An individual learning unit within a chapter, which can contain text, video, PDF, or assessment content.

assessment_questions
object[]
required

The list of questions for quiz or knowledge check lessons. Empty for non-assessment lesson types.

attachments
object[]
required

All supplementary files attached to this lesson returned as a flat array rather than a paginated connection.

content
string | null
required

The Markdown content body of the lesson. Null if the lesson has no text content.

Example:

"In this lesson, we will cover the basics of technical analysis..."

created_at
string<date-time>
required

The datetime the lesson was created.

Example:

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

days_from_course_start_until_unlock
integer | null
required

The number of days after a student starts the course before this lesson becomes accessible. Null if the lesson is available immediately.

Example:

42

embed_id
string | null
required

The external video identifier for embedded video lessons, such as a YouTube video ID or Loom share ID. Null if the lesson has no embed.

Example:

"dQw4w9WgXcQ"

embed_type
enum<string> | null
required

The platform type for the embedded video. One of: youtube, loom. Null if the lesson has no embed.

Available options:
youtube,
loom
id
string
required

The unique identifier for the lesson.

Example:

"lesn_xxxxxxxxxxxxx"

lesson_type
enum<string>
required

The content format of this lesson. One of: text, video, pdf, multi, quiz, knowledge_check.

Available options:
text,
video,
pdf,
multi,
quiz,
knowledge_check
main_pdf
object | null
required

The primary PDF document for PDF-type lessons. Null if this lesson is not a PDF lesson or no PDF has been uploaded.

order
integer
required

The sort position of this lesson within its parent chapter, starting from zero.

Example:

42

thumbnail
object | null
required

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

title
string
required

The display name of the lesson shown to students. Maximum 120 characters.

Example:

"Understanding Candlestick Patterns"

video_asset
object | null
required

The Mux video asset for video-type lessons, used for streaming playback. Null if this lesson has no hosted video.

visibility
enum<string>
required

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

Available options:
visible,
hidden