API Method: /api/tag/list
Get a list of tags.
Parameters
Parameter | Description |
---|---|
search | Search tags. |
reformat_tags_p |
Prettify tags to make them more humanly legiable. For example, change people:Santa-Claus to Santa Claus. Default: 0 Valid values: 1 and 0 |
exclude_machine_tags_p |
Exclude machine tags from the response. Default: 0 Valid values: 1 and 0 |
orderby |
Variable to order tags by. Default: tag Valid values: tag, count |
order |
Order of the objects in the response. Default: desc Valid values: desc and asc |
p | Page offset for the request. See [pagination](index#pagination) for details. |
size | Number of objects to include in the response. See [pagination](index#pagination) for details. |
Permission level
The minimum required permission level is:
anonymous
Example XML Response
<response status="ok" permission_level="anonymous" p="1" size="20" total_count="77" cached="1">
<tag tag="23" count="4" url="/tag/23"/>
<tag tag="3gpp" count="1" url="/tag/3gpp"/>
<tag tag="a" count="1" url="/tag/a"/>
( ...)
</response>
Example JSON Response
{
"status": "ok",
"permission_level":"anonymous",
"cached":"1",
"tags":[
{"tag": "23", "count": "4", "url": "/tag/23"},
{"tag": "3gpp", "count": "1", "url": "/tag/3gpp"},
{"tag": "a", "count": "1", "url": "/tag/a"},
(...)
],
"p": "1",
"size": "20",
"total_count": "77",
"site": { ... },
"endpoint": "/api/tag/list"
}