View a User

Example ID Request

cURL

$ curl \
-s https://api.intercom.io/users/5714dd359a3fd47136000001 \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'

cURL HTTP Request

HTTP/1.1 200 OK

{
    "type": "user",
    "id": "5714dd359a3fd47136000001",
    "user_id": "25",
    "anonymous": false,
    "email": "[e-mail]",
    "phone": "555671243",
    "name": "Hoban Washburne",
    "pseudonym": null,
  ...
}
# NB: Full User objects are returned

Ruby

intercom.users.find(:id => "5714dd359a3fd47136000001")

PHP

<?php

$user = $intercom->users->getUser("596f35f744c4c5f0cd30c8ef");
print_r($user->id);
?>

Example User ID Request

cURL

$ curl \
-s https://api.intercom.io/users?user_id=25 \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'

Ruby

intercom.users.find(:user_id => "128")

PHP

<?php

$user = $intercom->users->getUser("", ["user_id" => "111"]);
print_r($user->id);
?>

Java

Map<String, String> params = Maps.newHashMap();
params.put("user_id", "1");
User user = User.find(params);

Example Email Request

cURL

$ curl \
-s https://api.intercom.io/users?email=wash%40serenity.io \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'

Ruby

intercom.users.find(:email => "[e-mail]")

PHP

<?php

$user = $intercom->users->getUser("", ["email" => "[e-mail]"]);
print_r($user->id);
?>

Java

Map<String, String> params = Maps.newHashMap();
params.put("email", "[e-mail]");
User user = User.find(params);

Each user object has its own URL

• https://api.intercom.io/users/{id}

Where {id} is the value of the user's id field. This URL is the user's canonical address in the API.

Request Parameters

Parameter	Required	Description
user_id	no	The user id you have defined for the user
email	no	The email you have defined for the user

A user can also be fetched using a user_id or email parameter in the url, whose values are the company's user_id or email fields -

• https://api.intercom.io/users?user_id={user_id}
• https://api.intercom.io/users?email={email}

The email parameter value should be url encoded when sending.

Returns

A user object.

🚧

Note: When fetching users using an email or user_id parameter only the ones of type 'user' will be returned. However, it is possible to view a person of type 'contact' (lead) when viewing using their canonical address in the API, namely their id field.