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

# course

> The course object contains information about a specific course in your club.

## Properties

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

<ParamField path="name" type="string">
  The name of the course, configured in the course settings.
</ParamField>

<ParamField path="description" type="string">
  The description of the course, configured in the course settings.
</ParamField>

<ParamField path="logo_url" type="string">
  URL to the course's logo image.
</ParamField>

<ParamField path="certificate_enabled" type="boolean" default="false">
  Whether the course has certificates enabled.
</ParamField>

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

<ParamField path="custom_offer" type="custom_offer">
  Information about whether this course 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 course. See [user\_data](/en/members-area/reference/objects/user_data) for detailed properties.
</ParamField>

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

## Scope

It's accessible through `all_courses` object or `all_courses_values` array.

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

<Panel>
  <Tabs>
    <Tab title="Example">
      <CodeGroup>
        ```json Course theme={null}
        {
          "id": "course_123456",
          "name": "Complete Web Development Bootcamp",
          "description": "Learn web development from scratch with HTML, CSS, JavaScript and more.",
          "logo_url": "https://example.com/course-logo.jpg",
          "certificate_enabled": true,
          "thumbnail": "https://example.com/course-thumbnail.jpg",
          "custom_offer": {
            "enabled": true,
            "external_link": "https://example.com/purchase/course_123456"
          },
          "user_data": {
            "progress": 45,
            "visible": true,
            "content_count": 24
          },
          "modules": ["module_123", "module_456"]
        }
        ```
      </CodeGroup>
    </Tab>
  </Tabs>
</Panel>