List categories

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Returns a paginated list of post categories for one of your channels.

To limit the list of categories returned, use the following query parameters:

Parameter nameTypeDescription
isChildBooleanIf True, the endpoint returns only categories that have a parent category.
isParentBooleanIf True, the endpoint returns only parent categories, i.e. categories that have child categories.
pinnedBooleanIf True, the endpoint returns only pinned categories.
(Same result as in List pinned categories )

Header parameters channel and organization are required.

Query Params
number

Number of documents that will be returned

number

Page to search. Numbering starts with 0.

string

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.

boolean

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

boolean

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

boolean

If True, the endpoint returns only pinned categories.

Headers
string
required

Channel ID

string
required

The URL of the end-user web application

Response
200

Successful response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!