GETapi.synup.com/api/v4/sub-categories
Get SubCategories and AdditionalCategories
This API retrieves a list of the latest subcategories and additional categories available in the system.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Request
Request
curl -X GET 'https://api.synup.com/api/v4/sub-categories' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/sub-categories', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/sub-categories",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/sub-categories", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successfully retrieved categories. |
401 | Unauthorized. Invalid or missing API key. |
500 | Internal Server Error. |
Example response (generated from the schema)
{
"data": {
"subcategories": [
{
"databaseId": 0,
"id": "string",
"name": "string",
"primary": true
}
]
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | |
data.subcategories | array of object | required | |
data.subcategories[].databaseId | integer | required | Subcategory ID. |
data.subcategories[].id | string | required | Base64 encoded value of subcategory ID. |
data.subcategories[].name | string | required | Name of the subcategory. |
data.subcategories[].primary | boolean | required | If true, it is a subcategory that can be used as a primary category. If false, it is an additional category and cannot be used as a primary category. |