Search a Tag
This endpoint performs search to Tags.
info
This operation requires admin role.
HTTP Request
GET /api/v2/tag/search/
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 |
type | query | string | false | One of the following: 'user', 'category', 'contribution' |
active | query | string | false | If true, the tag is active |
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/search/',
{
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/search/ \
-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 |