Skip to main content

Get All Tags

This endpoint retrieves all tags

info

This operation requires authentication and admin role.

HTTP Request

GET /api/v2/tag/

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalseNumber of results to return per page.
offsetqueryintegerfalseThe initial index from which to return the results.
searchquerystringfalseA search term.
activequerystringfalseIs the tag active?
deletedquerystringfalseIs the tag deleted?
visiblequerystringfalseIs this tag publicly visible?
visibility_boostquerystringfalseThe tag add a visibility boost
orderingquerystringfalseOrdering fields (eg: ?ordering=name,created_at), default is -created_at (minus char is used for descending ordering)

Example Request


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

fetch('/api/v2/tag/',
{
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(Tag)falsenoneList of results

Example responses

{
"count": 123,
"next": "string(uri)",
"previous": "string(uri)",
"results": [
{
"id": 0,
"type": "string",
"name": "string",
"description": "string",
"color": "string",
"visible": true,
"visibility_boost": true,
"created_at": "2019-08-24T14:15:22Z",
"active": true,
"deleted": false
}
]
}