Get a list of a site's tags.
Resource Information
|
|
Method |
GET |
URL |
https://public-api.wordpress.com/rest/v1.1/sites/$site/tags |
Requires authentication? |
No |
Method Parameters
Parameter |
Type |
Description |
$site |
(int|string) |
Site ID or domain |
Query Parameters
Parameter |
Type |
Description |
context |
(string) |
- display:
- (default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
- edit:
- Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
|
http_envelope |
(bool) |
- false:
- (default)
- true:
- Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
|
pretty |
(bool) |
- false:
- (default)
- true:
- Output pretty JSON
|
meta |
(string) |
Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes |
fields |
(string) |
Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title |
callback |
(string) |
An optional JSONP callback function. |
number |
(int) |
The number of tags to return. Limit: 1000. Default: 100. |
offset |
(int) |
0-indexed offset. |
page |
(int) |
Return the Nth 1-indexed page of tags. Takes precedence over the offset parameter. |
search |
(string) |
Limit response to include only tags whose names or slugs match the provided search query. |
order |
(string) |
- ASC:
- (default) Return tags in ascending order.
- DESC:
- Return tags in descending order.
|
order_by |
(string) |
- name:
- (default) Order by the name of each tag.
- count:
- Order by the number of posts in each tag.
|
Response Parameters
Parameter |
Type |
Description |
found |
(int) |
The number of tags returned. |
tags |
(array) |
Array of tag objects. |
Resource Errors
This endpoint does not return any errors.