GET /users/suggest

Get a list of possible users to suggest for @mentions.

Resource Information

Method GET
Requires authentication? Yes

Query Parameters

Parameter Type Description
context (string)
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
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)
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_id (int) The site ID to look for matching users on.
site (string) The domain to look for matching users on. (Overrides site_id.)
filter (string) Optional. A string to filter possible users against.
image_size (int) Optional. The size of the image to return in pixels. (Default 96, minimum 1, maximum 2048.)
client (string) Optional. A string identifying the consumer of the data.

Response Parameters

Parameter Type Description
suggestions (array) A list of matching users (authors, editors and administrators.) The token holder must also be an author, editor or administrator on the site.

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
404 unknown_user User does not exist.


curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',

$context  = stream_context_create( $options );
$response = file_get_contents(
$response = json_decode( $response );


    "suggestions": [
            "ID": 78972699,
            "user_login": "apiexamples",
            "display_name": "apiexamples",
            "source": [
            "image_URL": "https:\/\/\/avatar\/a2afb7b6c0e23e5d363d8612fb1bd5ad?s=96&d=identicon&r=G"