Get Category

GET 
/courses/products/:productId/categories/:categoryId

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

Request

Version stringrequired

API Version

Available optionsv3

productId string<uuid>required

Product id

Possible values: non-empty

categoryId string<uuid>required

Category 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

Category id

titlestringrequired
descriptionstringnullablerequired
parentCategorystringnullablerequired
visibilitystringrequired
Available optionspublisheddraftlockeddrip
posterImagestringnullablerequired
sequenceNonumberrequired
dripDaysnumberrequired
metadataobjectnullablerequired
commentPermissionstringrequired
Available optionshiddenenabledlocked
lockedBystringnullablerequired
lockedByCategorystringnullablerequired
createdAtstringrequired
updatedAtstringrequired

Example (auto)

{
  "id": "b2c3d4e5-f678-4901-bcde-f12345678901",
  "title": "Module 1",
  "description": "First module",
  "parentCategory": "string",
  "visibility": "published",
  "posterImage": "string",
  "sequenceNo": 0,
  "dripDays": 0,
  "metadata": {
    "dripUnit": "days",
    "dripDate": "string"
  },
  "commentPermission": "hidden",
  "lockedBy": "string",
  "lockedByCategory": "string",
  "createdAt": "string",
  "updatedAt": "string"
}