Section Lessons

Returns a paginated list of lessons belonging to the specified section

Returns a paginated list of lessons belonging to the specified section.

GEThttps://example.thoughtindustries.com/incoming/v2/sections/:sectionId/lessons

Example 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	Unique identifier of the section whose lessons to list.
`cursor`	`string`	No	query	Opaque pagination cursor returned by a previous response; use to fetch the next page of results.
`perPage`	`integer`	No	query	The number of lessons to return per page.

Example response

{
  "pageInfo": {
    "total": 0,
    "cursor": "string",
    "hasMore": true
  },
  "lessons": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "title": "string",
      "slug": "example-slug",
      "accessLevel": "studentsOnly",
      "sectionTitle": "string",
      "topicCount": 0
    }
  ]
}

Response fields

Field	Type	Description
`pageInfo`	`CursorPageInfo`	Pagination metadata for the current result set.
`pageInfo.total`	`integer`	The total number of lessons across all pages.
`pageInfo.cursor`	`string`	Opaque cursor to pass in the next request to retrieve the following page.
`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.sectionTitle`	`string`	The display title of the section this lesson belongs to.
`lessons.topicCount`	`integer`	The number of topics contained within the lesson.