Developer Resources

This endpoint is deprecated in favor of version 2

Resource Information


Method	GET
URL	https://public-api.wordpress.com/rest/v1.1/me/keyring-connections/
Requires authentication?	Yes

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.
site	(string)	Optional. Only return connections for the given site.
force_external_users_refetch	(bool)	True to force refetch external users, default false
force_connection_test	(bool)	True to force testing the connection and not use the cache, default false

Response Parameters

Parameter	Type	Description
connections	(array)	List of Keyring connection. See /me/keyring-connection/%d for individual connection descriptions.

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code	Error Identifier	Error Message
403	authorization_required	This user is not authorized to access keyring connections on this site.
403	authorization_required	Access token does not have the required scope
403	authorization_required	An active access connection must be used to access keyring connections.
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.1/me/keyring-connections'

<?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.1/me/keyring-connections',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "connections": []
}