API Documentation

/circle
A High Level API operation used to get a user's tipping circle or social connections.
Production:
Test:
https://tippingcircle.com/rest/v1/circle
http://test.tippingcircle.com/rest/v1/circle

Request
  Param Description
* consumer_key Consumer key for the application.
* userId The user's unique id.  (Data type: int64)
* searchValue Possible values include: "everyone" (default if blank), "most-tips", "you-tipped", "tipped-you".  Also any value can search for users by name or email.
GET
/circle?consumer_key={consumer_key}&userId={userId}
&searchValue={searchValue}

Header
Content-Type: 'application/json'


Example
{
"consumer_key": "E4ZcTipHc3CozLB3jknSTK2et",
"userId": 123456
"searchValue": "most-tips"
}

Response
The success response includes a list of social connections which is the user's tipping circle.  Special permission is required to get the email address.
{
"success": true,
"message": "String content",
"errorCode": 0,
"myCircle": [{
"Email": "email@example.com",
"FirstName": "Jane",
"FullName": "Jane Doe",
"LastName": "Doe",
"ProfilePhotoUrl": "https://profilephotourl",
"SocialConnectionId": 987653,
"TippedYou": 23.00,
"YouTipped": 46.50
}]
}