GET /sites/$site/categories

Get a list of a site's categories.

Resource Information

   
Method GET
URL https://public-api.wordpress.com/rest/v1.1/sites/$site/categories
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 categories to return. Limit: 1000. Default: 100.
offset (int) 0-indexed offset.
page (int) Return the Nth 1-indexed page of categories. Takes precedence over the offset parameter.
search (string) Limit response to include only categories whose names or slugs match the provided search query.
order (string)
ASC:
(default) Return categories in ascending order.
DESC:
Return categories in descending order.
order_by (string)
name:
(default) Order by the name of each category.
count:
Order by the number of posts in each category.

Response Parameters

Parameter Type Description
found (int) The number of categories returned.
categories (array) Array of category objects.

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
403 unauthorized User cannot view taxonomy
403 unauthorized User cannot access this private blog.
403 unauthorized User cannot access this restricted blog
400 invalid_number The NUMBER parameter must be less than or equal to 1000.
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/categories/?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/categories/?number=5',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "found": 71,
    "categories": [
        {
            "ID": 270,
            "name": "Admin Bar",
            "slug": "admin-bar",
            "description": "",
            "post_count": 37,
            "parent": 0,
            "meta": {
                "links": {
                    "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/categories\/slug:admin-bar",
                    "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/categories\/slug:admin-bar\/help",
                    "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907"
                }
            }
        },
        {
            "ID": 276,
            "name": "Administration",
            "slug": "administration",
            "description": "",
            "post_count": 9,
            "parent": 0,
            "meta": {
                "links": {
                    "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/categories\/slug:administration",
                    "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/categories\/slug:administration\/help",
                    "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907"
                }
            }
        },
        {
            "ID": 357,
            "name": "Applications",
            "slug": "applications",
            "description": "",
            "post_count": 7,
            "parent": 0,
            "meta": {
                "links": {
                    "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/categories\/slug:applications",
                    "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/categories\/slug:applications\/help",
                    "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907"
                }
            }
        },
        {
            "ID": 413,
            "name": "Audio",
            "slug": "audio",
            "description": "",
            "post_count": 2,
            "parent": 0,
            "meta": {
                "links": {
                    "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/categories\/slug:audio",
                    "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/categories\/slug:audio\/help",
                    "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907"
                }
            }
        },
        {
            "ID": 55574,
            "name": "Automattic",
            "slug": "automattic",
            "description": "",
            "post_count": 44,
            "parent": 0,
            "meta": {
                "links": {
                    "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/categories\/slug:automattic",
                    "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907\/categories\/slug:automattic\/help",
                    "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/3584907"
                }
            }
        }
    ]
}