Get All Tags
This endpoint retrieves all tags
info
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/
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer | false | Number of results to return per page |
offset | query | integer | false | The initial index from which to return the results |
search | query | string | false | A search term |
active | query | string | false | If true, the tag is active |
type | query | string | false | One of the following: 'user', 'category', 'contribution' |
deleted | query | string | false | If true, the tag has been deleted |
visible | query | string | false | If true, this tag is publicly visible |
visibility_boost | query | string | false | The tag add a visibility boost |
ordering | query | string | false | Ordering fields (eg: ?ordering=name,created_at ), default is -created_at (minus char is used for descending ordering) |
Example Request
- JavaScript
- Bash
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);
});
# You can also use wget
curl -X GET /api/v2/tag/ \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}'
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response status code | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» count | integer | false | none | Total results count |
» next | string(uri)¦null | false | none | Next page url |
» previous | string(uri)¦null | false | none | Previous page url |
» results | list(Tag) | false | none | List of results |
Example responses
- 200
{
"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"
}
]
}