Skip to main content

Retrieve a category list

Retrieve a category list

Authorizations:Token, JWT
Query Parameters
pageintegerDefault: 1The collection page number
itemsPerPageinteger[0 .. 100]Default: 30The number of items per page
paginationbooleanEnable or disable pagination
filter.parentinteger>= 1Filter for "parent" field
order_by.posstringEnum: "asc""desc"Order rule for "pos" field

Responses

200Category Compact collection
Response schema:
Category Compact collection
Array
namestring
cleanUrlstring
showTitleboolean
iconobject or null
  • object
  • null
urlstring
widthinteger or null
heightinteger or null
altstring or null
bannerobject or null
  • object
  • null
urlstring
widthinteger or null
heightinteger or null
altstring or null
pathArray of objects
Array
idinteger
namestring
cleanUrlstring
hasSubcategoriesboolean
idinteger>= 1
401Unauthorized
Response schema:
Unauthorized
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
500Internal error
Response schema:
Internal error
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null