Categories

Retrieve an overview list of all categories from your website

get
Authorizations
x-api-keystringRequired
x-site-idstringRequired
Query parameters
per_pageintegerOptional

Number of items to retireve, maximum of 500

Example: 20
sort_typestringOptional

Property by which to sort the results

Example: created_at
sort_orderstringOptional

Order of results (asc or desc)

Example: desc
pageintOptional

Page to retrieve number, to be used with per_page

Example: 1
Responses
200

OK

No content

get
/categories

No content

Retrieve all data about an individual category

get
Authorizations
x-api-keystringRequired
x-site-idstringRequired
Path parameters
idstring · idRequired

The ID of the category

Example: 1234
Responses
200

OK

No content

get
/categories/{id}

No content

Update a category

put
Authorizations
x-api-keystringRequired
x-site-idstringRequired
Path parameters
idstringRequired

The Category ID

Example: 1
Body
namestringRequired
slugstringOptional
enabledstringRequired
weightingstringOptional
meta_titlestringOptional
meta_descstringOptional
og_titlestringOptional
og_descstringOptional
og_imagestringOptional
og_typestringOptional
twitter_typestringOptional
image_altstringOptional
parentstringOptional
Responses
200

OK

No content

put
/categories/{id}

No content

Create a category

post
Authorizations
x-api-keystringRequired
x-site-idstringRequired
Body
namestringRequired
slugstringOptional
enabledstringRequired
weightingstringOptional
meta_titlestringOptional
meta_descstringOptional
og_titlestringOptional
og_descstringOptional
og_imagestringOptional
og_typestringOptional
twitter_typestringOptional
image_altstringOptional
parentstringOptional
Responses
200

OK

No content

post
/categories/create

No content

Last updated

Was this helpful?