This document is generated by Aladia.

Aladia API

List All Chapters

Developing

GET

/courses/{courseId}/chapters

This endpoint returns all chapters on the specified course.

Optional query parameters:

version: a latest_published, latest or a valid mongo id.

cycleId: a mongodb ID used to fetch a specific cycle for the chapter

Returns:

All chapters within the specified course.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/courses/6655adf6efc95eeb791f8e65/chapters?version&cycleId&limit=50&next=&prev=&sortBy=&sortDirection=asc'

Response Example

200 - Success

{
  "data": [
    {
      "id": "e0e7cc93cccbfe758b4d0fdb",
      "courseId": "d20ead2e9195a343e8238bb5",
      "name": "Chapter 1",
      "description": "Chapter 1 description",
      "dates": {
        "startDate": "2004-01-02T02:52:15.009Z",
        "endDate": "2077-01-30T21:55:17.680Z"
      },
      "lectures": [
        "fbd67eecc59c8dad379d8631"
      ],
      "lecturesDuration": 23514,
      "completion": {
        "chapterId": "6662c783d003f900eb646083",
        "completions": [],
        "average": 0
      },
      "status": "draft",
      "createdAt": "2061-05-21T03:34:02.459Z",
      "updatedAt": "2006-12-26T11:55:14.714Z"
    }
  ],
  "cursor": {
    "next": null,
    "prev": null,
    "totalItems": 1
  }
}

Request

Path Params

courseId

string

required

course Id

Example:

6655adf6efc95eeb791f8e65

Query Params

version

string

optional

cycleId

string | null

optional

unique cycle identifier mongodb id

limit

integer

optional

Number of documents per page in the response

Default:

string

optional

Next token cursor, to navigate towards the next page

string

optional

Previous token cursor, to navigate towards the previous page

sortBy

string

optional

Optional field to be used as a sorting reference

sortDirection

enum<string>

optional

Set the results in ascending (asc) or descending (desc) direction

Allowed values:

ascdesc

Default:

asc

Responses

🟢200Success

application/json

Body

data

array[object (chapter.rto) {11}]

required

string

required

Primary key

courseId

string

optional

Course id

name

string

required

Chapter name

description

string

optional

Chapter description

dates

object (dates.model)

optional

Chapter dates

lectures

array[string]

optional

Chapter lectures

lecturesDuration

integer

optional

Total chapter lectures duration

status

string

optional

course status

mandatory

boolean

optional

is chapter mandatory?

createdAt

string

optional

date

updatedAt

string

optional

date

string

required

string

required

totalItems

integer

required

🟠422Parameter Error

Modified at 2025-04-12 09:46:35

Retrieve a Chapter

Search a Chapter