> ## 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.

# module

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

## Properties

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

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

<ParamField path="course_id" type="string">
  The ID of the course this module belongs to.
</ParamField>

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

<ParamField path="cover_image_desktop" type="string">
  URL to the desktop version of the module's cover image.
</ParamField>

<ParamField path="cover_image_mobile" type="string">
  URL to the mobile version of the module's cover image.
</ParamField>

<ParamField path="custom_offer" type="custom_offer">
  Information about whether this module 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="user_data">
  Data specific to the current user's interaction with the module. See [user\_data](/en/members-area/reference/objects/user_data) for detailed properties.
</ParamField>

<ParamField path="lessons" type="string[]">
  IDs of module's lessons.
</ParamField>

## Scope

It's accessible through `all_modules` object.

<Frame>
  ```mermaid theme={null}
  graph TD
      A[Global Context] --> B[all_modules]
      B --> C[module]
      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 Module theme={null}
        {
          "id": "module_789012",
          "name": "JavaScript Fundamentals",
          "course_id": "course_123456",
          "description": "Learn the core concepts of JavaScript programming language.",
          "thumbnail": "https://example.com/module-thumbnail.jpg",
          "cover_image_desktop": "https://example.com/module-cover-desktop.jpg",
          "cover_image_mobile": "https://example.com/module-cover-mobile.jpg",
          "custom_offer": {
            "enabled": false,
            "external_link": ""
          },
          "user_data": {
            "progress": 60,
            "visible": true,
            "content_count": 8
          },
          "lessons": ["lesson_123", "lesson_456"]
        }
        ```
      </CodeGroup>
    </Tab>
  </Tabs>
</Panel>