Skip to content

GET/sites/$site/users/login:$user_id

Get details of a user of a site by login.

Resource Information

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

Method Parameters

Parameter Type Description
$site (int|string) The site ID or domain.
$user_id (string) The user's login.

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.

Response Parameters

Parameter Type Description
ID (int) The ID of the user
login (string) The login username of the user
email (string) The email of the user
name (string) The name to display for the user
first_name (string) The first name of the user
last_name (string) The last name of the user
nice_name (string) The nice_name to display for the user
URL (string) The primary blog of the user
avatar_URL (url) Gravatar image URL
profile_URL (url) Gravatar Profile URL
site_ID (int) ID of the user's primary blog
roles (array|string) The role or roles of the user

Resource Errors

This endpoint does not return any errors.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1/sites/30434183/user/login:binarysmash'
<?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/30434183/user/login:binarysmash',
	false,
	$context
);
$response = json_decode( $response );
?>