Set your default language: PHP | Curl

GET users/checkins

Get a list of check-ins for the authenticated user.

Details

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

Parameters

Parameter Required Notes
access_token Access token of authenticated user to get information about (see authentication guides for assistance with getting an access token).
min_id Limit the result to no pings lower than this ID. This is useful for 'pull to refresh' functionality.

For example, you would take the last ping ID that the user has seen and set that as the min_id- No pings with an id lower than that will be returned in the timeline response.
max_id Limit the result to no pings higher than this ID. This is useful for paging to the next page of pings.

For example, if you pull a timeline page of 20 pings, and the last ID on the first page is 7838483, to get the next page, you would set that as the max_id, and all of the pings returned will have an ID less than 7838483.

The result is non-inclusive, and WILL NOT contain the ping data for 7838483.
count The number is pings you want returned. You can set this up to 200 max, after which we will limit the result to the last 200 pings.

Errors

In addition to the general errors documented, the following special errors may also be applicable:
Error Code Notes
403 The endpoint requires authentication while allowing users to get check-in data for a given user. The authenticated user must have permission to view the requested user's check-ins.

Example Usage

GET https://api.heello.com/users/:id/checkins.json
curl https://api.heello.com/users/checkins.json?access_token=ACCESS_TOKEN
// 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";

// You can get an access token and refresh token by implementing the auth
// flow described at (or use the demo provided):
// http://developer.heello.com/guides/authentication
$access_token = "ACCESS_TOKEN";

$api = new Heello\Client($api_application_key, $api_application_secret);
Heello\Client::config()->set_access_token($access_token);

try{
  // Returns a list of Ping(s) that have been designated as a checkin
  $checkins = $api->users->checkins(array(
    "count" => 1
  ));


  print_r($checkins);
} 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.