Get Course

GET 
/courses/products/:productId

Get a course by id. Requires a Location token with courses.readonly. Returns product columns and nested customizations.

Request

Version stringrequired

API Version

Available optionsv3

productId string<uuid>required

Product 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

Product id

titlestringrequired

Course title

descriptionstringnullablerequired
posterImagestringnullablerequired

Course poster image URL

customJsstringnullablerequired
customCssstringnullablerequired
customHeaderstringnullablerequired
customFooterstringnullablerequired
commentPrivacystringrequired
Available optionspublicinstructorOnlypublicAndInstructor
libraryOrdernumberrequired
createdAtstringrequired
updatedAtstringrequired
customizationsobjectnullablerequired

Example (auto)

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "title": "My Course",
  "description": "string",
  "posterImage": "https://cdn.example.com/course.png",
  "customJs": "string",
  "customCss": "string",
  "customHeader": "string",
  "customFooter": "string",
  "commentPrivacy": "public",
  "libraryOrder": 0,
  "createdAt": "2026-04-20T10:00:00.000Z",
  "updatedAt": "2026-04-20T10:00:00.000Z",
  "customizations": {
    "id": "d1e2f3a4-b5c6-4789-abcd-ef1234567890",
    "logoImage": "https://cdn.example.com/logo.png",
    "heroImage": "https://cdn.example.com/hero.png",
    "heroOverlayColor": "#000000",
    "heroTextAlignment": "centered",
    "heroSpacing": "medium",
    "favicon": "https://cdn.example.com/favicon.ico",
    "instructorHeading": "Your instructor",
    "instructorHeadshot": "https://cdn.example.com/instructor.png",
    "instructorName": "Jane Doe",
    "instructorTitle": "Lead instructor",
    "instructorBio": "Teaches this course",
    "templateId": null,
    "settings": null,
    "lessonSettings": null
  }
}