CallRail API v1 Documentation

Getting started with the CallRail API is simple. With this guide, you can make your first API request in a matter of minutes.

Obtaining your API Key

  1. From your CallRail dashboard, in the top right corner select ‘My Account’ -> ‘Account’.
  2. From the ‘Account’ sub-menu, select ‘API Access’.
  3. Click the button on the top right that says ‘Add API Key’.
  4. Your API Key will now appear in the table.

Authentication

The CallRail API authenticates via the HTTP Authorization header. Your request must include a header in the format:

Authorization: Token token="YOUR_API_KEY"

Formatting

The CallRail API is JSON formatted. When submitting JSON data in the request body via POST or PUT requests you must include a Content-Type header specifying the format.

Content-Type: application/json

Request Quota

Your API key can be used for up to 1,000 requests per day. If you expect that your application will require more requests, please contact our support team.

Making an API Request with cURL

To make an API request from the command line via cURL, run this command:

curl -H "Authorization: Token token=YOUR_API_KEY" \
  https://api.callrail.com/v1/companies.json

Making an API Request with Postman

A simple way to learn the CallRail API is to make an API request is with Postman, a powerful HTTP client to help easily test web services available on the Google Chrome Store.

General Parameters

These parameters are available for all methods which can return more than one object.

  • page: The page number of the current request. The first page is 1 (as opposed to 0).
  • per_page: The total number of objects to return in one request. The default value is 100 and the maximum value is 250.

General Response Fields

These items are returned from all methods which can return more than one object.

  • page: The page number of the current request.
  • per_page: The total number of objects to return in one request.
  • total_entries: The total number of objects that fit your query parameters.
  • total_pages: The total number of pages that fit your query parameters.

CallRail API Objects

  1. API v1 - Companies
  2. API v1 - Users
  3. API v1 - Sources
  4. API v1 - Source Trackers
  5. API v1 - Session Trackers
  6. API v1 - Call and SMS Alerts
  7. API v1 - Calls
  8. API v1 - Tags
  9. API v1 - Integrations

Example Code