API Documentation

CallGrid API Documentation

Looking for the API Reference?

Use our REST API to automate tagging, tracking, routing, reporting, or campaign management.

Go to API Reference

Introduction

Welcome to the CallGrid API documentation. This guide provides everything you need to integrate with our call tracking and analytics platform.

Getting Started

To get started with the CallGrid API:

  1. Create an account at app.callgrid.com/signup
  2. Navigate to your account settings to generate API keys
  3. Review the authentication section below
  4. Start making API calls to our endpoints

Authentication

The CallGrid API uses API key authentication. Include your API key in the Authorization header as a Bearer token. The API supports multiple body formats including JSON and URL-encoded data.

curl -X GET "https://api.callgrid.com/api/call" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Pagination

All endpoints support pagination. You can specify page andlimit query parameters to control the results returned.

curl -X GET "https://api.callgrid.com/api/call?page=1&limit=100" \
  -H "Authorization: Bearer YOUR_API_KEY"

Using the API

Here's an example API call demonstrating date filtering and pagination:

curl -X GET "https://api.callgrid.com/api/call?startDate=2025-01-01&endDate=2025-01-31" \
  -H "Authorization: Bearer YOUR_API_KEY"

Error Handling

The API provides detailed error messages in the response body to help with debugging. Common HTTP status codes include:

  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 429 - Rate limit exceeded
  • 500 - Internal server error

Rate Limiting

The API has a rate limit of 100 requests per minute. When you exceed this limit, you'll receive a 429 status code. Rate limit information is included in response headers.

Webhooks

CallGrid supports webhooks for real-time notifications. Webhooks can integrate with CRMs, dialers, routing systems, and other tools.

Example webhook configuration:

{
  "url": "https://your-app.com/webhook",
  "events": ["call.completed", "call.answered"],
  "secret": "your_webhook_secret"
}

API Reference

For detailed endpoint documentation, request/response schemas, and interactive API testing:

View Full API Reference