Search CourseSections

GET

api

content

coursesections

curl --request GET \
  --url https://spaces.nexudus.com/api/content/coursesections \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/coursesections"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/coursesections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A CourseSection is a structural grouping that organises lessons within a 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`

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.

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.

Enums

eLessonUnlockType — UnlockType values

Value	Name
1	Immediate
2	Sequential
3	Timed

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the course this section belongs to.

string

Filter by title of the parent course.

string

Filter by section title displayed to members.

string

Filter by optional HTML or rich-text introductory content shown at the top of the section.

boolean

Filter by whether the section is active and visible to enrolled members.

integer

Filter by position of the section within the course; lower numbers appear first.

integer

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).

string

Filter by stored filename of the section thumbnail image (read-only; use NewImageUrl to set).

string

Filter by uRL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).

boolean

Filter by set to true to remove the existing thumbnail image.

integer

Filter by number of days after enrolment before the section unlocks; only used when UnlockType is Timed (3).

Range Filters

integer

Filter by position of the section within the course; lower numbers appear first greater than or equal to this value.

integer

Filter by position of the section within the course; lower numbers appear first less than or equal to this value.

integer

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.

integer

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.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/content/coursesections?page=1&size=15&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/coursesections?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Title',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/coursesections',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Title',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Title

curl -X GET \
  "https://spaces.nexudus.com/api/content/coursesections?CourseSection_Title=example-value&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/coursesections?' + new URLSearchParams({
    CourseSection_Title: 'example-value',
    orderBy: 'Title',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/coursesections',
    params={
        'CourseSection_Title': 'example-value',
        'orderBy': 'Title',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/content/coursesections?from_CourseSection_UpdatedOn=2025-01-01T00:00&to_CourseSection_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/coursesections?' + new URLSearchParams({
    from_CourseSection_UpdatedOn: '2025-01-01T00:00',
    to_CourseSection_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/coursesections',
    params={
        'from_CourseSection_UpdatedOn': '2025-01-01T00:00',
        'to_CourseSection_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

CourseSection[]

The list of CourseSection records matching the query. See the Get one CourseSection endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each CourseSection. The following fields are not populated in the Records[] response: SectionContents, UnlockType.To get all fields, fetch the full record using the Get one CourseSection endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "CourseId": 0,
      "CourseTitle": null,
      "Title": "",
      "Active": false,
      "DisplayOrder": 0,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "UnlockAfterDays": 0,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "CourseSection Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one CourseSectionRetrieve a single CourseSection record by its Id.

Search CourseSections

curl --request GET \
  --url https://spaces.nexudus.com/api/content/coursesections \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/coursesections"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/coursesections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Title

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Title

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Title

Range filters

Response

200