Siteglide.comAdminRoadmap

Categories

Retrieve an overview list of all categories from your website

get
Authorizations
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
get
GET /api/site/v2/categories HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*

No content

Retrieve all data about an individual category

get
Authorizations
Path parameters
idstring · idRequired

The ID of the category

Example: 1234
Responses
200
OK
get
GET /api/site/v2/categories/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*

No content

Update a category

put
Authorizations
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
put
PUT /api/site/v2/categories/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "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"
}
No content

Create a category

post
Authorizations
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
post
POST /api/site/v2/categories/create HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "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"
}
No content
PreviousFormsNextModules

Last updated

Was this helpful?