Section Lessons
Returns a paginated list of lessons belonging to the specified section
Returns a paginated list of lessons belonging to the specified section.
GET
https://example.thoughtindustries.com/incoming/v2/sections/:sectionId/lessonsExample request
curl "https://example.thoughtindustries.com/incoming/v2/sections/:sectionId/lessons" \
-H 'Authorization: Bearer YOUR_API_KEY'Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
sectionId | uuid | Yes | path | The sectionId identifier. |
page | integer | No | query | The page number to retrieve in the paginated result set. |
perPage | integer | No | query | The number of lessons to return per page. |
Example response
{
"data": {
"APISectionLessons": {
"pageInfo": {
"perPage": 0,
"currentPage": 0,
"total": 0,
"hasMore": true
},
"lessons": [
{
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"slug": "example-slug",
"accessLevel": "studentsOnly",
"sectionId": "00000000-0000-0000-0000-000000000000",
"sectionTitle": "string",
"topicCount": 0
}
]
}
}
}Response fields
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | Pagination metadata for the result set. |
pageInfo.perPage | integer | The number of lessons returned per page. |
pageInfo.currentPage | integer | The current page number in the paginated result set. |
pageInfo.total | integer | The total number of lessons across all pages. |
pageInfo.hasMore | boolean | Indicates whether additional pages of results are available. |
lessons | APILessonInfo[] | The list of lessons belonging to the section. |
lessons.id | uuid | The unique identifier of the lesson. |
lessons.title | string | The display title of the lesson. |
lessons.slug | string | The URL-friendly identifier for the lesson. |
lessons.accessLevel | AccessLevel | The access restriction applied to the lesson, such as studentsOnly. |
lessons.sectionId | uuid | The unique identifier of the section this lesson belongs to. |
lessons.sectionTitle | string | The display title of the section this lesson belongs to. |
lessons.topicCount | integer | The number of topics contained within the lesson. |