Retrieve a list of category
Retrieve a list of category
Authorizations:Token, JWT
Query Parameters
page | integerDefault: 1 The collection page number |
itemsPerPage | integer[0 .. 100]Default: 30 The number of items per page |
pagination | booleanEnable or disable pagination |
order_by.position | stringEnum: "asc" "desc" Order rule for "position" field |
filter.parent | integerFilter for "parent" field |
Responses
200Category collection
Response schema:
Category collection Array
enabled | booleanDefault: true | ||||||||||
show_title | booleanDefault: true | ||||||||||
position | integer | ||||||||||
memberships | Array of integers | ||||||||||
parent | integer | ||||||||||
clean_url | string | ||||||||||
name | string[1 .. 255] charactersDefault: "Category name" | ||||||||||
description | stringDefault: "Description" | ||||||||||
meta_tags | string | ||||||||||
meta_description_type | stringDefault: "A" Enum: "A" "C" | ||||||||||
meta_description | string | ||||||||||
meta_title | string | ||||||||||
icon | object or null | ||||||||||
| |||||||||||
banner | object or null | ||||||||||
| |||||||||||
og_meta_tags | string | ||||||||||
useCustomOG | boolean | ||||||||||
id | integer>= 1 |
401Unauthorized
Response schema:
Unauthorized type | stringExample: "https://tools.ietf.org/html/rfc2616#section-10" |
title | stringExample: "An error occurred" |
detail | string or nullExample: "Cannot find entity" |
instance | string or null |
500Internal error
Response schema:
Internal error type | stringExample: "https://tools.ietf.org/html/rfc2616#section-10" |
title | stringExample: "An error occurred" |
detail | string or nullExample: "Cannot find entity" |
instance | string or null |