This document is generated by Aladia.

Search a Chapter

Developing

GET

/courses/{courseId}/chapters/search

This endpoint filter the chapters using the chapter name.

Expected query parameters:

name: the term used to search and filter the chapter using the chapter name as a query

Returns:

An array of Chapters objects which partially match the query, inside a data property, as well as the pagination properties

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/courses//chapters/search?name&limit=50&next=&prev=&sortBy=&sortDirection=asc' \
--header 'apikey: '

Response Example

200 - Success

{
    "data": [
        {
            "id": "da9ed9ac7e642ccb4cb43bf9",
            "courseId": "88afcd0f1cc99ef30a8eb60f",
            "name": "Chapter 1",
            "description": "demand-driven",
            "dates": {
                "startDate": "2024-02-12T07:51:44.278Z",
                "endDate": "2094-03-03T14:17:22.201Z"
            },
            "lectures": [
                "b9877977aa5a7c7afccd5fdb"
            ],
            "lecturesDuration": 72767,
            "completion": {
                "chapterId": "6662c783d003f900eb646083",
                "completions": [],
                "average": 0
            },
            "status": "draft",
            "createdAt": "2038-02-24T08:08:38.259Z",
            "updatedAt": "2008-09-09T17:07:28.336Z"
        }
    ],
    "cursor": {
        "next": null,
        "prev": null,
        "totalItems": 1
    }
}

Request

Path Params

Query Params

Header Params

Responses

🟢200Success

application/json

Body

🟠401Unauthorized

🟠403Forbidden

🟠422Parameter Error

Modified at 2025-04-08 15:41:05

Retrieve All Chapters

Delete a Chapter