v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB
Categories

List categories

get/categories

Query parameters

pageSizenumber

Number of documents that will be returned

pagenumber

Page to search. Numbering starts with 0.

sortBystring

The sort-by field name and order. Format: <field_name>.<asc|desc> (asc for ascending and desc for descending order). If no order is specified, descending order is used.

isChildboolean

If True, the endpoint returns only categories that have a parent category.

isParentboolean

If True, the endpoint returns only parent categories, i.e. categories that have child categories.

pinnedboolean

If True, the endpoint returns only pinned categories.

Headers

channelstring required

Channel ID

organizationstring required

The URL of the end-user web application

Response

Successful response