Skip to main content
CategoryVersion: v3New

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:courses.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

productIdstring<uuid>required

Product id

Possible values: non-empty

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890
categoryIdstring<uuid>required

Category id

Possible values: non-empty

Example:b2c3d4e5-f678-4901-bcde-f12345678901

Query Parameters

locationIdstringrequired

Location id or sub-account id is required.

Possible values: non-empty

Example:ve9EPM428h8vShlRW1KT

Response

application/json

Success

idstringrequired

Category id

Example:b2c3d4e5-f678-4901-bcde-f12345678901
titlestringrequired
Example:Module 1
descriptionstringnullablerequired
Example:First module
parentCategorystringnullablerequired
visibilitystringrequired
Available optionspublisheddraftlockeddrip
posterImagestringnullablerequired
sequenceNonumberrequired
dripDaysnumberrequired
metadataobjectnullablerequired
commentPermissionstringrequired
Available optionshiddenenabledlocked
lockedBystringnullablerequired
lockedByCategorystringnullablerequired
createdAtstringrequired
updatedAtstringrequired