🔗Categories

Retrieve an overview list of all categories from your website

get

/api/public/site/categories

Authorizations

SessionKeySiteID

Query parameters

per_pageinteger

Number of items to retireve, maximum of 500

Example: 20

sort_typestring

Property by which to sort the results

Example: created_at

sort_orderstring

Order of results (asc or desc)

Example: desc

pageint

Page to retrieve number, to be used with per_page

Example: 1

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/categories' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Retrieve all data about an individual category

get

/api/public/site/categories/{id}

Authorizations

SessionKeySiteID

Path parameters

idstring · idrequired

The ID of the category

Example: 1234

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/categories/{id}' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Update a category

put

/api/public/site/categories/{id}

Authorizations

SessionKeySiteID

Path parameters

idstringrequired

The Category ID

Example: 1

Body

namestringrequired

slugstring

enabledstringrequired

weightingstring

meta_titlestring

meta_descstring

og_titlestring

og_descstring

og_imagestring

og_typestring

twitter_typestring

image_altstring

parentstring

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/public/site/categories/{id}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "slug": "text",
    "enabled": "text",
    "weighting": "text",
    "meta_title": "text",
    "meta_desc": "text",
    "og_title": "text",
    "og_desc": "text",
    "og_image": "text",
    "og_type": "text",
    "twitter_type": "text",
    "image_alt": "text",
    "parent": "text"
  }'

200

401

403

422

200

No body

OK

Create a category

post

/api/public/site/categories/create

Authorizations

SessionKeySiteID

Body

namestringrequired

slugstring

enabledstringrequired

weightingstring

meta_titlestring

meta_descstring

og_titlestring

og_descstring

og_imagestring

og_typestring

twitter_typestring

image_altstring

parentstring

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/site/categories/create' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "slug": "text",
    "enabled": "text",
    "weighting": "text",
    "meta_title": "text",
    "meta_desc": "text",
    "og_title": "text",
    "og_desc": "text",
    "og_image": "text",
    "og_type": "text",
    "twitter_type": "text",
    "image_alt": "text",
    "parent": "text"
  }'

200

401

403

404

422

200

No body

OK