Skip to main content

Get All Categories

This endpoint retrieves all categories.

info

This operation requires authentication only if content_availability community option is false.

info

To filter the category list by a tag id please refer to Get Categories tagged with a Specific Tag

HTTP Request

GET /api/v2/category/

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalseNumber of results to return per page
offsetqueryintegerfalseThe initial index from which to return the results
searchquerystringfalseA search term
activequerystringfalseFilter using field active (only if user is administrator)
deletedquerystringfalseFilter using field deleted (only if user is administrator)

Example Request


const headers = {
'Accept':'application/json',
'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/category/',
{
method: 'GET',

headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});

Responses

StatusMeaningDescriptionSchema
200OKResponse status codeInline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
» countintegerfalsenoneTotal results count
» nextstring(uri)¦nullfalsenoneNext page url
» previousstring(uri)¦nullfalsenonePrevious page url
» resultslist(Category)falsenoneList of results

Example responses

{
"count": "integer",
"next": "string(uri)",
"previous": "string(uri)",
"results": [
{
"id": "integer",
"tags": [{Tag}],
"followed": "boolean",
"order": "integer",
"name": "string",
"name_synonyms": "string",
"slug": "string",
"slogan": "string",
"html_info": "string",
"seo_title": "string",
"seo_description": "string",
"auto_follow": "string",
"active": "boolean",
"image_original": "string",
"image_bigger": "string",
"image_big": "string",
"image_medium": "string",
"image_small": "string",
"emotional_image_original": "string",
"emotional_image_position": "integer",
"lastmod_datetime": "string",
"stream_order_by": "string",
"followers_counter": "integer",
"parents": ["integer"]
}
]
}