Skip to main content

Get All Tags

This endpoint retrieves all tags


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

This operation can be done by normal (not administrators) users and it will return only a public visible and active tag and only some public tag details.

If this operation has been done by an administrator user it will show all tag details and not active, not visible or deleted tag also.

HTTP Request

GET /api/v2/tag/


limitqueryintegerfalseNumber of results to return per page
offsetqueryintegerfalseThe initial index from which to return the results
searchquerystringfalseA search term
activequerystringfalseIf true, the tag is active
typequerystringfalseOne of the following: 'user', 'category', 'contribution'
deletedquerystringfalseIf true, the tag has been deleted
visiblequerystringfalseIf true, this tag is 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 = {
'Authorization': 'Bearer {access_token}'

method: 'GET',
headers: headers
.then(function(res) {
return res.json();
}).then(function(body) {


200OKResponse status codeInline

Response Schema

Status Code 200

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

Example responses

"count": "integer",
"next": "string(uri)",
"previous": "string(uri)",
"results": [
"id": "integer",
"type": "string",
"name": "string",
"description": "string",
"color": "string",
"visible": "boolean",
"visibility_boost": "boolean",
"created_at": "string",
"active": "boolean",
"deleted": "boolean"