GET /sites/$site/taxonomies/$taxonomy/terms

Get a list of a site's terms by taxonomy.

Resource Information

   
Method GET
URL https://public-api.wordpress.com/rest/v1.1/sites/$site/taxonomies/$taxonomy/terms
Requires authentication? No

Method Parameters

Parameter Type Description
$site (int|string) Site ID or domain
$taxonomy (string) Taxonomy

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 terms to return. Limit: 1000. Default: 100.
offset (int) 0-indexed offset.
page (int) Return the Nth 1-indexed page of terms. Takes precedence over the offset parameter.
search (string) Limit response to include only terms whose names or slugs match the provided search query.
order (string)
ASC:
(default) Return terms in ascending order.
DESC:
Return terms 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 terms returned.
terms (array) Array of tag objects.

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
400 invalid_number The number parameter must be less than or equal to 1000.
400 invalid_taxonomy The taxonomy does not exist
403 unauthorized User cannot view taxonomy
403 unauthorized User cannot access this private blog.
403 unauthorized User cannot access this restricted blog
403 unauthorized User cannot edit taxonomy
400 invalid_context Invalid API CONTEXT

Example

curl 'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/taxonomies/post_tags/terms?number=5'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/taxonomies/post_tags/terms?number=5',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "success": true,
    "i_like": false,
    "like_count": 0,
    "meta": {
        "links": {
            "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/comments\/147564\/likes\/mine\/delete\/help",
            "post": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/posts\/9612",
            "comment": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/comments\/147564",
            "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907"
        }
    }
}