Welcome to the CallGrid Documentation. This documentation is designed to help you understand how to use the CallGrid API.
Getting Started
To get started, you will need to create an account and generate an API key. You can do this by visiting the Signup page. Once you have created an account you can generate an API key by visiting the API Keys page. Once you have generated an API key, you can start using the API.
Authentication
All API requests must be authenticated using your API key. You can pass your API key in the apiKey URL parameter or in the POST body as apiKey to authenticate your requests. Our API will accept both application/json and www/url-encoded body formats.
Pagination
All of our API endpoints support pagination. You can specify the page and limit query parameters to paginate the results.
Using the API
Downloading calls from the API is as simple as making a GET request to the /call endpoint. You can filter calls by date and paginate the results.
Our API returns detailed error messages in the response body. If an error occurs, the response will include a message field with a description of the error.
Rate Limiting
Our API has a rate limit of 100 requests per minute. If you exceed this limit, you will receive a 429 Too Many Requests response.
Webhooks
Our API supports webhooks for real-time notifications. You can create webhooks to receive notifications for various events or also to receive data from CRMs, Dialers, or other systems prior to routing a call to check agent availability or any other information. Please visit the Webhooks page to create a Webhook.
API Reference
For the detailed API reference, please visit the API Reference page