Skip to main content
GET
/
api
/
content
/
courselessons
/
{id}
{
  "CourseId": 123,
  "CourseTitle": "<string>",
  "SectionId": 123,
  "SectionDisplayOrder": 123,
  "SectionTitle": "<string>",
  "InstructorId": 123,
  "InstructorFullName": "<string>",
  "InstructorCompanyName": "<string>",
  "InstructorTeamNames": "<string>",
  "Title": "<string>",
  "SummaryText": "<string>",
  "LessonContents": "<string>",
  "Active": true,
  "DisplayOrder": 123,
  "UnlockType": 123,
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "UnlockAfterDays": 123,
  "CompletionType": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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:
ValueMeaning
ImmediateAvailable as soon as the member enrols
SequentialUnlocked only after the previous lesson is completed
TimedUnlocked after a number of days specified by UnlockAfterDays
CompletionType — defines what action marks the lesson as done:
ValueMeaning
NoneNo completion tracking
VisitedMarked complete when the member opens the lesson
ButtonMember must click a completion button
VideoMember 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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the CourseLesson record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/courselessons/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
CourseId
integer
ID of the course this lesson belongs to.
​
CourseTitle
string
Title of the parent course.
​
SectionId
integer
ID of the course section this lesson belongs to (optional; lessons without a section appear ungrouped).
​
SectionDisplayOrder
integer
Display order of the parent section.
​
SectionTitle
string
Title of the parent section.
​
InstructorId
integer
ID of the coworker attributed as instructor for this lesson (optional; overrides the course-level host for this lesson).
​
InstructorFullName
string
Instructor full name.
​
InstructorCompanyName
string
Instructor company name.
​
InstructorTeamNames
string
Comma-separated list of teams the instructor belongs to.
​
Title
string
Lesson title displayed to members.
​
SummaryText
string
Short summary shown in the lesson listing.
​
LessonContents
string
Full HTML or rich-text body of the lesson displayed to members when they open it.
​
Active
boolean
Whether the lesson is active and visible to enrolled members.
​
DisplayOrder
integer
Position of the lesson within its section (or the course if unsectioned); lower numbers appear first.
​
UnlockType
integer
When the lesson becomes available: Immediate (1), after the previous lesson is done — Sequential (2), or after a set number of days — Timed (3). See eLessonUnlockType enum values: 1 = Immediate, 2 = Sequential, 3 = Timed.
​
ImageFileName
string
Stored filename of the lesson thumbnail image (read-only; use NewImageUrl to set).
​
NewImageUrl
string
URL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
​
ClearImageFile
boolean
Set to true to remove the existing thumbnail image.
​
UnlockAfterDays
integer
Number of days after enrolment before the lesson unlocks; only used when UnlockType is Timed (3).
​
CompletionType
integer
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.. See eLessonCompletionType enum values: 1 = None, 2 = Visited, 3 = Button, 4 = Video.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "CourseId": 0,
  "CourseTitle": null,
  "SectionId": null,
  "SectionDisplayOrder": null,
  "SectionTitle": null,
  "InstructorId": null,
  "InstructorFullName": null,
  "InstructorCompanyName": null,
  "InstructorTeamNames": null,
  "Title": "",
  "SummaryText": null,
  "LessonContents": null,
  "Active": false,
  "DisplayOrder": 0,
  "UnlockType": 0,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "UnlockAfterDays": 0,
  "CompletionType": 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
}