Sign in
Category

Get category by key

This method is for customers who use their own custom identifiers when it comes to categories.

get/category/getbykey/{key}

Path parameters

keystring required

an unique reference to get a category

Response

OK

CategoryIdinteger

The id of the category. Uniquely identifies a category

Keystring

The key of the category. If feature 'Use alphanumeric category IDs' is enabled, this will be used as identifier instead of id.

Namestring

The name of the category

Rankinteger

The rank of the category

Status'Active' | 'InActive'

The status of the category

Parentsinteger[]

The parents of the category

Urlstring

The category url

Changes