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.

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
200OKnoneInline

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": 123,
"next": "string(uri)",
"previous": "string(uri)",
"results": [
{
"id": 0,
"tags": [],
"followed": false,
"order": 123,
"name": "string",
"name_synonyms": "string",
"slug": "string",
"slogan": "string",
"html_info": "string",
"seo_title": "string",
"seo_description": "string",
"auto_follow": "none",
"active": true,
"image_original": "string",
"image_bigger": "string",
"image_big": "string",
"image_medium": "string",
"image_small": "string",
"emotional_image_original": "string",
"emotional_image_position": 0,
"lastmod_datetime": "2019-08-24T14:15:22Z",
"stream_order_by": "recent",
"followers_counter": 13
}
]
}