Get page categories

get

https://{endpoint}/v1/content/sites/{site_id}/page-categories

This API allows us to obtain list of page categories

Path Params

site_id

uuid

required

ID of the site

Query Params

size

integer

1 to 1000

Defaults to 50

Number of page categories to return per page

nextPageToken

integer

Token for fetching the next page of results

sortBy

string

enum

Defaults to createdNewest

Sorting method for page categories

term

string

length ≤ 255

Search term for filtering page categories

skipEmptyPageCategories

boolean

Defaults to false

Whether to skip empty page categories in the response

useMultilevelVersion

boolean

Defaults to false

When true, uses the multilevel list implementation. Event and album published counts (publishAlbumCount, publishEventCount, publishContentCount) are returned on this path when event and album category is enabled. Required for includeRootCategoriesPages, includeHierarchy, and parentCategoryId to take effect.

includeRootCategoriesPages

boolean

Defaults to false

Only effective when useMultilevelVersion is true. When true, returns nested child categories (listOfItems) and content under each root (listOfPages), matching the intranet multilevel list behavior.

parentCategoryId

string

Only effective when useMultilevelVersion is true. Filter categories under the specified parent category.

includeHierarchy

boolean

Only effective when useMultilevelVersion is true. When true, returns categories in a hierarchical tree (nested listOfItems).

Responses

200Success

400Error

401Authorize error

403Forbidden error