Set your default language: PHP | Curl

GET checkins/:id

Used for retrieving information about a given check-in. Note a check-in is just a special kind of Ping, the same information can be retrieved via pings/show. The exception on this endpoint is that while an ID may be a valid Ping ID, if it's not also a check-in a 404 Not Found is returned.

Details

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

Parameters

Parameter Required Notes
:id The ID of the given check-in to retrieve. Note: This is just a Ping ID, however if the Ping isn't a checkin, a 404 is returned.

Errors

In addition to the general errors documented, the following special errors may also be applicable:
Error Code Notes
404 Not Found. While you may search for a valid Ping ID, if it's not a check-in, this endpoint will return a 404.

Example Usage

GET https://api.heello.com/checkins/:id.json
curl https://api.heello.com/checkins/1.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";

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

try{
  // checkins->show is essentially an alias to pings->show
  // difference here is if you supply a valid ping id that is not a checkin
  // a 404 is returned.
  $ping = $api->checkins->show(array(
    "id" => 1
  ));

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