Course Sections

Returns a paginated list of sections belonging to the specified course

Returns a paginated list of sections belonging to the specified course.

GEThttps://example.thoughtindustries.com/incoming/v2/courses/:courseId/sections

Example request

curl "https://example.thoughtindustries.com/incoming/v2/courses/:courseId/sections" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`courseId`	`uuid`	Yes	path	The courseId identifier.
`page`	`integer`	No	query	Page number to retrieve in the paginated result set.
`perPage`	`integer`	No	query	Number of sections to return per page.

Example response

{
  "data": {
    "APICourseSections": {
      "pageInfo": {
        "perPage": 0,
        "currentPage": 0,
        "total": 0,
        "hasMore": true
      },
      "sections": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "title": "string",
          "slug": "example-slug",
          "status": "draft",
          "releaseAt": "2024-01-01T00:00:00.000Z",
          "parentSectionId": "00000000-0000-0000-0000-000000000000",
          "lessonCount": 0
        }
      ]
    }
  }
}

Response fields

Field	Type	Description
`pageInfo`	`PageInfo`	Pagination metadata for the result set.
`pageInfo.perPage`	`integer`	Number of sections returned per page.
`pageInfo.currentPage`	`integer`	The current page number in the paginated result set.
`pageInfo.total`	`integer`	Total number of sections across all pages.
`pageInfo.hasMore`	`boolean`	Indicates whether additional pages of results are available.
`sections`	`APISectionInfo[]`	Array of section objects belonging to the course.
`sections.id`	`uuid`	Unique identifier for the section.
`sections.title`	`string`	Display title of the section.
`sections.slug`	`string`	URL-friendly identifier for the section.
`sections.status`	`Status`	Publication status of the section (e.g., `draft` or `published`).
`sections.releaseAt`	`ISO 8601 timestamp`	Date and time when the section becomes available to learners, in ISO 8601 format.
`sections.parentSectionId`	`uuid`	Unique identifier of the parent section, if this section is nested.
`sections.lessonCount`	`integer`	Total number of lessons within the section.