Skip to main content

Get Categories tagged with a Specific Tag

This endpoint retrieves all Categories tagged with a Specific Tag

info

This operation requires authentication and admin role.

HTTP Request

GET /api/v2/tag/category/

Parameters

NameInTypeRequiredDescription
tag_idqueryintegerfalseA unique integer value identifying this tag
tag_namequerystringfalseA unique name identifying this tag for the selected type (path)
limitqueryintegerfalseNumber of results to return per page
offsetqueryintegerfalseThe initial index from which to return the results
orderingquerystringfalseOrdering field, default is order (minus char is used for descending ordering)

One between "tag_id" and "tag_name" must be passed to this endpoint.

Available ordering fields

ValueDescription
orderCustom order
idid of the category
namename of the category

Example Request


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

fetch('/api/v2/tag/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": [
{Category}
]
}