Jump to content

Community

REST API Documentation

/cms/categories/{database_id}


Get list of database categories

Parameters

No parameters are accepted for this endpoint.

Exceptions

Code Message Description
2T306/1 INVALID_DATABASE The database ID does not exist or the authorized user does not have permission to view it
2T306/2 DATABASE_DOES_NOT_USE_CATEGORIES The database does not use categories

Response

Name Type Description
page int The page number for the results being shown
perPage int The number of results that will be on each page
totalResults int The total number of results
totalPages int The number of pages of results
results array of categories objects The results for this page

categories object

Name Type Description
id int ID number
name string Name
url string URL
class string Node class
parentId int|null Parent Node ID
permissions object|null Node permissions
×
×
  • Create New...

Important Information

We use technologies, such as cookies, to customise content and advertising, to provide social media features and to analyse traffic to the site. We also share information about your use of our site with our trusted social media, advertising and analytics partners. See more about cookies and our Privacy Policy