Clarity API

This API is not currently supported.

Search

Members

Call Requests


Search API Details

GET /search — /search/{q}

Search for users, optionally filtering by organization.

Parameters
q
(required)
A URL encoded search string
organization_route
(optional)
Filter by a specific organization. You must be a member.
Example Request
GET http://api.clarity.fm/1/search?q=ruby
{
   "users":[
      {
         "id":6,
         "image_url":"http://s3.amazonaws.com/clarityfm-staging/users/pictures/6/profile_square/picture?1331916954",
         "name":"Scott Wadden",
         "first_name":"Scott",
         "last_name":"Wadden",
         "location":"Moncton, NB",
         "bio":"Lead engineer at Clarity. Husband and father of 2. Passionate about code.",
         "nickname":"scottwadden",
         "hourly_rate":0.0
      }
   ],
   "matches":1
}

Members API Details

GET /members — /members/{id}

Show Clarity member details. Query by Clarity ID, Twitter handle or email address.

Parameters
id
(optional)
A Clarity ID to query for.
twitter
(optional)
A Twitter handle to query for.
email
(optional)
An email address to query for.
Example Request
GET http://api.clarity.fm/1/members?id=danmartell
{
   "hourly_rate":0,
   "created_at":1319123931,
   "first_name":"Dan",
   "gender":"male",
   "id":7,
   "image_url":"http://s3.amazonaws.com/clarityfm-staging/users/pictures/7/profile_square/BIO%20-%20Headshot.jpg?1332179519",
   "bio":"Canadian Entrepreneur.  Founder of Clarity - Angel Investor (15 tech startups). Co-Founder of Flowtown (Acquired 11'), Founder of Spheric Technologies (Acquired 08'), Mentor @ 500Startup, GrowLabs & theC100.org",
   "last_name":"Martell",
   "location":"San Francisco, California",
   "nickname":"danmartell",
   "timezone":"Atlantic Time (Canada)",
   "updated_at":1341858640,
   "timezone_offset":-3.0,
   "timezone_label":"ADT",
   "non_personal_completed_calls_count":1598,
   "verified_phone_number":true,
   "profile_page_views_count":2404,
   "linkedin_profile_url":"http://www.linkedin.com/x/profile/7qvyw2754dt5/8bn1Mfx4Ce",
   "facebook_profile_url":"https://facebook.com/829175116",
   "twitter_profile_url":"http://twitter.com/account/redirect_by_id?id=10638782",
   "charity_name":"charity: water"
}

Call Request API Details

GET /call-requests

Show all active call requests for the current user. Requires authentication.

Example Request
GET http://api.clarity.fm/1/call-requests
[
   {
      "callback_expires_at":null,
      "created_at":1341984457,
      "id":3757,
      "name":null,
      "rate":"0.0",
      "reason":"test4",
      "updated_at":1341984457,
      "charity_name":"charity: water",
      "seeker_name":"Scott Wadden",
      "speaker_name":"Dan Martell",
      "seeker_location":"Sackville, New Brunswick",
      "speaker_location":San Francisco, California",
      "seeker_image_url":"http://s3.amazonaws.com/clarityfm-staging/users/pictures/6/profile_square/71bf1f7ff8c81f63943872340fc3d4b3.jpg?1338521223",
      "speaker_image_url":"http://s3.amazonaws.com/clarityfm-staging/users/pictures/7/profile_square/BIO%20-%20Headshot.jpg?1332179519",
      "seeker_timezone_offset":-3.0,
      "speaker_timezone_offset":-3.0,
      "seeker_nickname":"scottwadden",
      "speaker_nickname":"danmartell",
      "seeker_timezone_label":"ADT",
      "speaker_timezone_label":"ADT",
      "seeker_user_id":6,
      "speaker_user_id":7
   }
]

GET /call-requests/{id}

Shows a specific call request belonging to the current user. Requires authentication.

Parameters
id
(required)
The call request to show. Must belong to the authenticated user.
Example Request
GET http://api.clarity.fm/1/call-requests/3757
{
  "callback_expires_at":null,
  "created_at":1341984457,
  "id":3757,
  "name":null,
  "rate":"0.0",
  "reason":"test4",
  "updated_at":1341984457,
  "charity_name":"charity: water",
  "seeker_name":"Scott Wadden",
  "speaker_name":"Dan Martell",
  "seeker_location":"Sackville, New Brunswick",
  "speaker_location":San Francisco, California",
  "seeker_image_url":"http://s3.amazonaws.com/clarityfm-staging/users/pictures/6/profile_square/71bf1f7ff8c81f63943872340fc3d4b3.jpg?1338521223",
  "speaker_image_url":"http://s3.amazonaws.com/clarityfm-staging/users/pictures/7/profile_square/BIO%20-%20Headshot.jpg?1332179519",
  "seeker_timezone_offset":-3.0,
  "speaker_timezone_offset":-3.0,
  "seeker_nickname":"scottwadden",
  "speaker_nickname":"danmartell",
  "seeker_timezone_label":"ADT",
  "speaker_timezone_label":"ADT",
  "seeker_user_id":6,
  "speaker_user_id":7
}

POST /call-requests

Creates a new call request between member_id and the authenticated user. Requires authentication.

Parameters (JSON object)
member_id
(required)
The member to create a call back with. Obtain the member id with GET /members.
reason
(required)
The reason for the call.
Example Request
POST http://api.clarity.fm/1/call-requests
{
  "callback_expires_at":null,
  "created_at":1341984457,
  "id":3757,
  "name":null,
  "rate":"0.0",
  "reason":"test4",
  "updated_at":1341984457,
  "charity_name":"charity: water",
  "seeker_name":"Scott Wadden",
  "speaker_name":"Dan Martell",
  "seeker_location":"Sackville, New Brunswick",
  "speaker_location":San Francisco, California",
  "seeker_image_url":"http://s3.amazonaws.com/clarityfm-staging/users/pictures/6/profile_square/71bf1f7ff8c81f63943872340fc3d4b3.jpg?1338521223",
  "speaker_image_url":"http://s3.amazonaws.com/clarityfm-staging/users/pictures/7/profile_square/BIO%20-%20Headshot.jpg?1332179519",
  "seeker_timezone_offset":-3.0,
  "speaker_timezone_offset":-3.0,
  "seeker_nickname":"scottwadden",
  "speaker_nickname":"danmartell",
  "seeker_timezone_label":"ADT",
  "speaker_timezone_label":"ADT",
  "seeker_user_id":6,
  "speaker_user_id":7
}

DELETE /call-requests/{id}

Deletes the specified call request. Requires authentication.

Parameters
id
(required)
The call request to delete. Must belong to the authenticated user.
Example Request
DELETE http://api.clarity.fm/1/call-requests/3757
HTTP 200