Developer Resources

Resource Information


Method	GET
URL	https://public-api.wordpress.com/rest/v1.1/sites/$site/follows/
Requires authentication?	Yes

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.
page	(int)	page number Default: 1.
number	(int)	number of followers to return Default: 20.

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code	Error Identifier	Error Message
403	unauthorized	Current user does not have required capability to view follows.
403	unauthorized	User cannot access this private blog.
403	unauthorized	User cannot access this restricted blog

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1/sites/82974409/follows'

<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
    ),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1/sites/82974409/follows',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "found": 1,
    "users": [
        {
            "ID": 78972699,
            "login": "apiexamples",
            "name": "apiexamples",
            "nice_name": "apiexamples",
            "URL": "http:\/\/apiexamples.wordpress.com",
            "avatar_URL": "https:\/\/1.gravatar.com\/avatar\/a2afb7b6c0e23e5d363d8612fb1bd5ad?s=96&d=identicon&r=G",
            "profile_URL": "https:\/\/en.gravatar.com\/apiexamples",
            "ip_address": false,
            "site_ID": 82974409,
            "site_visible": true
        }
    ]
}