Search CourseLessons

GET

api

content

courselessons

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

import requests

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

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/courselessons', 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 CourseLesson is an individual learning unit within a Course. Lessons are the building blocks that customers complete to work through a course’s content. Each lesson belongs to a Course and optionally to a CourseSection that groups related lessons together. Lessons have two key behavioural settings: UnlockType — controls when a lesson becomes available to enrolled members:

Value	Meaning
Immediate	Available as soon as the member enrols
Sequential	Unlocked only after the previous lesson is completed
Timed	Unlocked after a number of days specified by `UnlockAfterDays`

CompletionType — defines what action marks the lesson as done:

Value	Meaning
None	No completion tracking
Visited	Marked complete when the member opens the lesson
Button	Member must click a completion button
Video	Member must finish watching the embedded video (must be hosted on YouTube)

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 CourseLesson-List role.

Enums

eLessonUnlockType — UnlockType values

Value	Name
1	Immediate
2	Sequential
3	Timed

eLessonCompletionType — CompletionType values

Value	Name
1	None
2	Visited
3	Button
4	Video

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 lesson belongs to.

string

Filter by title of the parent course.

integer

Filter by iD of the course section this lesson belongs to (optional; lessons without a section appear ungrouped).

integer

Filter by display order of the parent section.

string

Filter by title of the parent section.

integer

Filter by iD of the coworker attributed as instructor for this lesson (optional; overrides the course-level host for this lesson).

string

Filter by instructor full name.

string

Filter by instructor company name.

string

Filter by comma-separated list of teams the instructor belongs to.

string

Filter by lesson title displayed to members.

string

Filter by short summary shown in the lesson listing.

string

Filter by full HTML or rich-text body of the lesson displayed to members when they open it.

boolean

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

integer

Filter by position of the lesson within its section (or the course if unsectioned); lower numbers appear first.

integer

Filter by when the lesson becomes available: Immediate (1), after the previous lesson is done — Sequential (2), or after a set number of days — Timed (3).

string

Filter by stored filename of the lesson 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 lesson unlocks; only used when UnlockType is Timed (3).

integer

Filter by how completion is tracked: None (1), Visited (2), completion Button (3), or Video watched (4). Video completion requires the lesson to embed a YouTube-hosted video..

Range Filters

integer

Filter by display order of the parent section greater than or equal to this value.

integer

Filter by display order of the parent section less than or equal to this value.

integer

Filter by position of the lesson within its section (or the course if unsectioned); lower numbers appear first greater than or equal to this value.

integer

Filter by position of the lesson within its section (or the course if unsectioned); lower numbers appear first less than or equal to this value.

integer

Filter by number of days after enrolment before the lesson 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 lesson 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/courselessons?page=1&size=15&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/courselessons?' + 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/courselessons',
    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/courselessons?CourseLesson_Title=example-value&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/courselessons?' + new URLSearchParams({
    CourseLesson_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/courselessons',
    params={
        'CourseLesson_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/courselessons?from_CourseLesson_UpdatedOn=2025-01-01T00:00&to_CourseLesson_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/courselessons?' + new URLSearchParams({
    from_CourseLesson_UpdatedOn: '2025-01-01T00:00',
    to_CourseLesson_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/courselessons',
    params={
        'from_CourseLesson_UpdatedOn': '2025-01-01T00:00',
        'to_CourseLesson_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

CourseLesson[]

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

Partial records — The listing endpoint returns a summary representation of each CourseLesson. The following fields are not populated in the Records[] response: LessonContents, UnlockType, CompletionType.To get all fields, fetch the full record using the Get one CourseLesson 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,
      "SectionId": null,
      "SectionDisplayOrder": null,
      "SectionTitle": null,
      "InstructorId": null,
      "InstructorFullName": null,
      "InstructorCompanyName": null,
      "InstructorTeamNames": null,
      "Title": "",
      "SummaryText": null,
      "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": "CourseLesson 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 CourseLessonRetrieve a single CourseLesson record by its Id.

Search CourseLessons

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

import requests

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

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/courselessons', 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