latestOpenAPI 3.1.02026-08-183894205.8 MB

f67a043e3190

Course chapters

List course chapters

Returns a paginated list of chapters within a course, ordered by position.

Required permissions:

  • courses:read
get/course_chapters

Query parameters

afterstring

Returns the elements in the list that come after the specified cursor.

beforestring

Returns the elements in the list that come before the specified cursor.

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
course_idstring required

The unique identifier of the course to list chapters for.

Example:cors_xxxxxxxxxxxxx

Response

A successful response

Example response

{
  "data": [
    {
      "id": "chap_xxxxxxxxxxxxx",
      "order": 42,
      "title": "Getting Started"
    }
  ]
}