v8

latestOpenAPI 3.1.02026-08-033623795.0 MB

Course chapters

Retrieve course chapter

Retrieves the details of an existing course chapter.

Required permissions:

courses:read

get/course_chapters/{id}

Path parameters

idstring required

Example:chap_xxxxxxxxxxxxx

The unique identifier of the chapter to retrieve.

Response

A successful response

idstring required

The unique identifier for the chapter.

orderinteger required

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

titlestring required

The display name of the chapter shown to students. Maximum 150 characters.

Example response

{
  "id": "chap_xxxxxxxxxxxxx",
  "lessons": [
    {
      "id": "lesn_xxxxxxxxxxxxx",
      "order": 42,
      "title": "Understanding Candlestick Patterns"
    }
  ],
  "order": 42,
  "title": "Getting Started"
}