> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kiwify.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# lesson

> The lesson object contains information about a specific lesson within a module.

## Properties

<ParamField path="id" type="string">
  Unique identifier for the lesson.
</ParamField>

<ParamField path="name" type="string">
  The name of the lesson.
</ParamField>

<ParamField path="course_id" type="string">
  Identifier of the course this lesson belongs to.
</ParamField>

<ParamField path="module_id" type="string">
  Identifier of the module this lesson belongs to.
</ParamField>

<ParamField path="published" type="boolean" default="true">
  Whether the lesson is published and accessible.
</ParamField>

<ParamField path="thumbnail" type="string">
  URL to the lesson's thumbnail image.
</ParamField>

<ParamField path="video_thumbnail" type="string">
  URL to the lesson's thumbnail generated from its video.
</ParamField>

<ParamField path="thumbnail_slider_cover" type="string">
  URL to the lesson's thumbnail image used in slider views.
</ParamField>

<ParamField path="custom_offer" type="custom_offer">
  Information about whether this lesson can be purchased inside the members area. See [custom\_offer](/en/members-area/reference/objects/custom_offer) for detailed properties.
</ParamField>

<ParamField path="user_data" type="lesson_user_data">
  Data specific to the current user's interaction with the lesson. See [lesson\_user\_data](/en/members-area/reference/objects/lesson_user_data) for detailed properties.
</ParamField>

## Scope

It's accessible through `all_lessons` object.

<Frame>
  ```mermaid theme={null}
  graph TD
      A[Global Context] --> B[all_lessons]
      B --> C[lesson]
      style A fill:#f9f9f9,stroke:#333,stroke-width:2px,color:#333,stroke-dasharray: 5 5
      style B fill:#4B96FF,stroke:#333,stroke-width:1px,color:white,font-weight:bold;
      style C fill:#FFFFFF,stroke:#333,stroke-width:1px,color:#666;
      linkStyle 0 stroke:#4B96FF,stroke-width:2px
  ```
</Frame>

<Panel>
  <Tabs>
    <Tab title="Example">
      <CodeGroup>
        ```json Lesson theme={null}
        {
          "id": "lesson_567890",
          "name": "JavaScript Variables and Data Types",
          "course_id": "course_123456",
          "module_id": "module_789012",
          "published": true,
          "thumbnail": "https://example.com/lesson-thumbnail.jpg",
          "thumbnail_slider_cover": "https://example.com/lesson-slider-cover.jpg",
          "video_thumbnail": "https://example.com/video-thumbnail.jpg",
          "custom_offer": {
            "enabled": false,
            "external_link": ""
          },
          "user_data": {
            "progress": 0,
            "visible": true,
            "expired": false,
            "delivery_date": ""
          }
        }
        ```
      </CodeGroup>
    </Tab>
  </Tabs>
</Panel>
