Get Lesson

GET 
/courses/products/:productId/lessons/:lessonId

Get a lesson by id. Requires a Location token with courses.readonly. Returns the full lesson object.

Request

Version stringrequired

API Version

Available optionsv3

productId string<uuid>required

Product id

Possible values: non-empty

lessonId string<uuid>required

Lesson id

Possible values: non-empty

locationId stringrequired

Location id or sub-account id is required.

Possible values: non-empty

application/json

Success

application/json

Schema

Schema

idstringrequired

Lesson id

titlestringrequired
descriptionstringnullablerequired
categoryIdstringrequired
visibilitystringrequired
Available optionsdraftpublishedlocked
posterImagestringnullablerequired
sequenceNonumberrequired
commentStatusstringrequired
Available optionsvisiblehiddenlocked
contentIdstringnullablerequired
contentTypestringrequired
Available optionsvideoassignmentquizaudiofunnel
commentPermissionstringrequired
Available optionshiddenenabledlocked
lockedByPoststringnullablerequired
lockedByCategorystringnullablerequired
certificateTemplateIdstringnullablerequired
metaDataobjectnullablerequired
createdAtstringrequired
updatedAtstringrequired

Example (auto)

{
  "id": "c3d4e5f6-7890-4123-cdef-123456789012",
  "title": "Lesson 1",
  "description": "string",
  "categoryId": "string",
  "visibility": "draft",
  "posterImage": "string",
  "sequenceNo": 0,
  "commentStatus": "visible",
  "contentId": "string",
  "contentType": "video",
  "commentPermission": "hidden",
  "lockedByPost": "string",
  "lockedByCategory": "string",
  "certificateTemplateId": "string",
  "metaData": {},
  "createdAt": "string",
  "updatedAt": "string"
}