Categories
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
Number of items to retireve, maximum of 500
20
Property by which to sort the results
created_at
Order of results (asc or desc)
desc
Page to retrieve number, to be used with per_page
1
OK
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Not Found - The form does not contain any cases
Unprocessable Entity - Required data missing or data invalid
GET /api/site/v2/categories HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*
No content
The ID of the category
1234
OK
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Not Found - Case does not exist
Unprocessable Entity - Required data missing or data invalid
GET /api/site/v2/categories/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*
No content
The Category ID
1
OK
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Unprocessable Entity - Required data missing or data invalid
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
OK
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Not Found - Case does not exist
Unprocessable Entity - Required data missing or data invalid
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