module

Example

{
  "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"]
}

Example

{
  "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"]
}

Properties

string

Unique identifier for the module.

string

The name of the module.

string

The ID of the course this module belongs to.

string

URL to the module’s thumbnail image.

string

URL to the desktop version of the module’s cover image.

string

URL to the mobile version of the module’s cover image.

custom_offer

Information about whether this module can be purchased inside the members area. See custom_offer for detailed properties.

user_data

Data specific to the current user’s interaction with the module. See user_data for detailed properties.

string[]

IDs of module’s lessons.

Scope

It’s accessible through all_modules object.

Introduction

Key Concepts

References

Properties

Scope

​Properties

​Scope

Properties

Scope