Person Resource
This resource is used to retrieve information about a person, identified using an email address or email address hash.
Resource URL
http://api.rapleaf.com/v2/person/{email address}
GET Request
Example Request
GET http://api.rapleaf.com/v2/person/dummy@rapleaf.com HTTP/1.1 Authorization: 25234823472To send the Authorization header from your browser for testing purposes see the "Help" section at the bottom of this page.
Parameter Descriptions
| Parameter | Value | Description |
|---|---|---|
| Authorization Header | API Key (Required) | The API key is the unique key assigned to you by Rapleaf.
You can find your API Key here.
For testing (or if circumstances require it) you can send the API key in the query string using 'api_key=' |
| Email Address | An email address (Required) | This is the email address you are searching. The example above shows "dummy@rapleaf.com".
Note: Email addresses containing special characters such as "+" or "=" must be URL-encoded so that they are communicated correctly. For example, the address "dum+my@rapleaf.com" would be encoded as "dum%2Bmy%40rapleaf.com". |
GET Response
HTTP Status Codes
| Status Code | Description |
|---|---|
| 200 OK | Request processed successfully. |
| 202 Accepted | This person is currently being searched. Check back shortly and we should have data. |
| 400 Bad Request | Invalid email address. |
| 401 Unauthorized | API key was not provided or is invalid. |
| 403 Forbidden | Your query limit has been exceeded. Contact developer@rapleaf.com if you would like to increase your limit. |
| 404 Not Found | Only returned for lookup by hash. We do not have this email in our system and are not able to create a person using a hash. If you would like better results, consider supplying the unhashed email address. |
| 500 Internal Server Error | There was an unexpected error on our server. This should be very rare and if you see it please contact developer@rapleaf.com. |
Response Schema Definitions
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<person id="n0bbroIW">
<basics>
<name>Test Dummy</name>
<age>42</age>
<gender>Male</gender>
<location>San Francisco, CA, US</location>
<occupations>
<occupation job_title="Test Dummy" company="Rapleaf.com"/>
<occupation job_title="Comedian"/>
</occupations>
<universities>
<university>Berkeley</university>
</universities>
<earliest_known_activity>Thu Feb 23 11:45:06 -0800 2006</earliest_known_activity>
<latest_known_activity>Tue Sep 25 11:01:42 -0700 2007</latest_known_activity>
<num_friends>42</num_friends>
</basics>
<memberships>
<primary>
<membership site="amazon.com" exists="true"/>
<membership site="bebo.com" exists="false"/>
<membership site="blackplanet.com" exists="false"/>
<membership site="classmates.com" exists="false"/>
<membership site="facebook.com" exists="false"/>
<membership site="flickr.com" exists="false"/>
<membership site="flixster.com" profile_url="http://www.flixster.com/user/dummy" image_url="http://images.flixster.com/profile/dummy.jpg" exists="true"/>
<membership site="friendster.com" profile_url="http://profiles.friendster.com/5563" exists="true"/>
<membership site="hi5.com" profile_url="http://www.hi5.com/friend/4927" exists="true"/>
<membership site="linkedin.com" profile_url="http://linkedin.com/profile?viewProfile=&key=31212" exists="true"/>
<membership site="livejournal.com" exists="false"/>
<membership site="multiply.com" exists="false"/>
<membership site="myspace.com" profile_url="http://profile.myspace.com/index.cfm?fuseaction=user.viewprofile&friendID=26448756" exists="true" num_friends="42"/>
<membership site="plaxo.com" exists="true"/>
<membership site="ringo.com" exists="false"/>
<membership site="tickle.com" exists="true"/>
<membership site="360.yahoo.com" exists="false"/>
</primary>
<supplemental>
<membership site="amazon.com/gp/registry/wishlist" profile_url="http://www.amazon.com/gp/registry/registry.html?type=wishlist&id=D5Z2DTHWZQ9Q" exists="true"/>
<membership site="ecademy.com" profile_url="http://www.ecademy.com/account.php?sha=1a886d0cf" exists="true"/>
<membership site="tribe.com" profile_url="http://people.tribe.net/208cdbb3-1ac8a2886" exists="true"/>
<membership site="tribe.com" profile_url="http://people.tribe.net/a8b373d1-208c3b960" exists="true"/>
<membership site="yelp.com" profile_url="http://www.yelp.com/user_details?userid=DdfDOLCAA" exists="true"/>
</supplemental>
</memberships>
<reputation>
<score>79</score>
<commerce_score>33</commerce_score>
<percent_positive>73.9%</percent_positive>
<rapleaf_profile_url>http://www.rapleaf.com/np/n0bbroIW/Dummy</rapleaf_profile_url>
<badges>
<badge type="badge1">http://www.rapleaf.com/badge1/n0bbroIW.jpg</badge>
<badge type="badge2">http://www.rapleaf.com/badge2/n0bbroIW.jpg</badge>
<badge type="small">http://www.rapleaf.com/sig/n0bbroIW.jpg</badge>
</badges>
</reputation>
</person>
Memberships Section
Note: <supplemental> memberships only includes tags with exists="true"
| Attribute | Description |
|---|---|
| site | The url of the site (without the "www.") |
| exists | One of four values: "true" - the person is a member "false" - the person is not a member "tbd" - the person has not been searched for yet, but will be soon "unknown" - the person has not been searched for yet and we are not currently searching this site Note: Memberships that have been made private by their owners will be shown as "false". |
| profile_url | The url of the person's profile. This attribute is only present when exists="true" and we know the profile url. |
| image_url | The url of the person's profile image. This attribute is only present when exists="true" and we know the profile image url. |
| num_friends | The number of friends the person has on this site. This attribute is only present when exists="true" and we know the number of friends. |
Using SHA1 Hash of Email
Instead of supplying the email address as a string you can use a SHA1 hash of it. However, this will only be able to return results if we already have the email in our system.
Note: The email address must be put into lower case before it is hashed.
Client Libraries
These libraries make it even easier for you to integrate the Person API functionality into your PHP, Python, and Ruby applications. Rapleaf is providing these links as a convenience and cannot take any responsibility for the libraries.
Help
For testing we recommend using a helpful Firefox Add-on called Modify Headers which lets you set the HTTP headers of your web requests. By setting the Authorization header to your API Key you can experiment with API requests within your browser.
You can learn more about the basic principles of REST on Wikipedia.
For a more in depth understanding we recommend RESTful Web Services by Leonard Richardson and Sam Ruby.
Please email questions to Rapleaf Developer Support.
