Set your default language: PHP | Curl

GET users/lookup

Used to get complete user information from a list of user ID's. Usually used in conjunction with endpoints that return a list of user ID's.

Details

URL https://api.heello.com/users/lookup.format
Requires Authentication No
Rate Limited Yes
Response Formats json

Parameters

Parameter Required Notes
ids Comma separated list of user ID's. Limit 100 (only the first 100 are used).
access_token Optionally include relationship information of users being looked up to user designated by the access_token.
username Force the 'ids' parameter to refer to a list of usernames instead of user ID.

Possible values are 1 or 0.

Errors

There are no unique error states for this endpoint, please see our page detailing general errors you may encounter.

Example Usage

GET https://api.heello.com/users/lookup.json
curl https://api.heello.com/users/lookup.json?key=APPLICATION_KEY&ids=1,2
// Note: PHP Examples use the Heello PHP Client library
// https://github.com/Heello/heello-php
require_once dirname(dirname(dirname(__FILE__))) . '/Heello.php';

// You can get an Application Key and Secret by visiting:
// http://developer.heello.com/apps
$api_application_key = "APPLICATION_KEY";
$api_application_secret = "APPLICATION_SECRET";

$api = new Heello\Client($api_application_key, $api_application_secret);

try{
  // Get an array of Heello user representations
  $users = $api->users->lookup(array(
    "ids" => "1,2"
    )
  );

  print_r($users);
} catch (Exception $e){
  print $e->getMessage();
}
Please use the "Live Demo" below to see an example response.
You may need to login or create an account before making requests against the API.

Live Demo

Please login and create an application to perform live API testing.