Skip to main content

Retrieve a list of category

Retrieve a list of category

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

Responses

200Category collection
Response schema:
Category collection
Array
enabledbooleanDefault: true
show_titlebooleanDefault: true
positioninteger
membershipsArray of integers
parentinteger
clean_urlstring
namestring[1 .. 255] charactersDefault: "Category name"
descriptionstringDefault: "Description"
meta_tagsstring
meta_description_typestringDefault: "A"Enum: "A""C"
meta_descriptionstring
meta_titlestring
iconobject or null
  • object
  • null
idinteger
altstring
urlstring
widthinteger
heightinteger
bannerobject or null
  • object
  • null
idinteger
altstring
urlstring
widthinteger
heightinteger
og_meta_tagsstring
useCustomOGboolean
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