CourseSections
Search CourseSections
Search and list CourseSection records with filtering, sorting, and pagination.
GET
A CourseSection is a structural grouping that organises lessons within a
Sections are optional — lessons can belong directly to a course without a section. However, using sections can help create a clearer learning path for members, and allows you to unlock groups of lessons at once.
Course. Sections represent milestones or learning stages — each section should bring the member one step closer to the course’s overall learning goal.
Sections are ordered by DisplayOrder and can be set to unlock immediately or after a delay, using the same UnlockType / UnlockAfterDays mechanism as individual lessons:
| UnlockType | Meaning |
|---|---|
| Immediate | Section is available as soon as the member enrols |
| Sequential | Unlocked only after the previous section is completed |
| Timed | Unlocked after the number of days specified by UnlockAfterDays |
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CourseSection-List role.Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by iD of the course this section belongs to.
Filter by title of the parent course.
Filter by section title displayed to members.
Filter by optional HTML or rich-text introductory content shown at the top of the section.
Filter by whether the section is active and visible to enrolled members.
Filter by position of the section within the course; lower numbers appear first.
Filter by when the section becomes available: Immediate (1), after the previous section is done — Sequential (2), or after a set number of days — Timed (3).
Filter by stored filename of the section thumbnail image (read-only; use
NewImageUrl to set).Filter by uRL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
Filter by set to true to remove the existing thumbnail image.
Filter by number of days after enrolment before the section unlocks; only used when UnlockType is Timed (3).
Range Filters
Filter by position of the section within the course; lower numbers appear first greater than or equal to this value.
Filter by position of the section within the course; lower numbers appear first less than or equal to this value.
Filter by number of days after enrolment before the section unlocks; only used when UnlockType is Timed (3) greater than or equal to this value.
Filter by number of days after enrolment before the section unlocks; only used when UnlockType is Timed (3) less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Title
Range filters
Response
200
The list of CourseSection records matching the query. See the Get one CourseSection endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response