v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring categories

Retrieve all the taxonomies and their children.

Retrieve all the taxonomies and thier children. Optional depth query string limits the depth of the categories returned.<br />User roles: admin, manager, editor, viewer

get/authoring/v2/categories

Query parameters

offsetnumber

Use the offset parameter to specify the number of content items to skip from the beginning of the list and return the rest.

limitnumber

Set the limit for the maximum number of content items to return in a single result. The default value is 50.

depthnumber

Used to specify the depth of the children to return. 1 -7 returns the given depth. Values above 7 or no value result in all categories.

Response

The child categories were successfully retrieved.

limitinteger

The page size.

offsetinteger

The number of items to skip from the beginning of the list.

hrefstring

A link to the current page.

nextstring

A link to the next page. Only shown if a next page exists.

previousstring

A link to the previous page. Only shown if a previous page exists.

Example response

{
  "limit": 50,
  "href": "/authoring/v2/categories?depth=2&limit=10&offset=10",
  "next": "/authoring/v2/categories?depth=2&limit=2&offset=20",
  "previous": "/authoring/v2/categories?depth=2&limit=2&offset=0"
}