CallRail

SKILL.md

---
name: callrail
description: |
  CallRail API integration with managed OAuth. Track and analyze phone calls, manage tracking numbers, companies, and tags.
  Use this skill when users want to access call data, manage tracking numbers, view call analytics, or organize calls with tags.
  For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway).
compatibility: Requires network access and valid Maton API key
metadata:
  author: maton
  version: "1.0"
  clawdbot:
    emoji: 🧠
    requires:
      env:
        - MATON_API_KEY
---

# CallRail

Access the CallRail API with managed OAuth authentication. Track calls, manage tracking numbers, analyze call data, and organize with tags.

## Quick Start

```bash
# List all calls
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/callrail/v3/a/{account_id}/calls.json')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
```

## Base URL

```
https://api.maton.ai/callrail/{native-api-path}
```

Maton proxies requests to `api.callrail.com` and automatically injects your OAuth token.

## Authentication

All requests require the Maton API key in the Authorization header:

```
Authorization: Bearer $MATON_API_KEY
```

**Environment Variable:** Set your API key as `MATON_API_KEY`:

```bash
export MATON_API_KEY="YOUR_API_KEY"
```

### Getting Your API Key

1. Sign in or create an account at [maton.ai](https://maton.ai)
2. Go to [maton.ai/settings](https://maton.ai/settings)
3. Copy your API key

## Connection Management

Manage your CallRail OAuth connections at `https://api.maton.ai`.

### List Connections

```bash
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections?app=callrail&status=ACTIVE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
```

### Create Connection

```bash
python <<'EOF'
import urllib.request, os, json
data = json.dumps({'app': 'callrail'}).encode()
req = urllib.request.Request('https://api.maton.ai/connections', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
```

### Get Connection

```bash
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
```

**Response:**
```json
{
  "connection": {
    "connection_id": "{connection_id}",
    "status": "ACTIVE",
    "creation_time": "2026-02-10T09:55:17.574212Z",
    "last_updated_time": "2026-02-10T09:55:34.693801Z",
    "url": "https://connect.maton.ai/?session_token=...",
    "app": "callrail",
    "metadata": {}
  }
}
```

Open the returned `url` in a browser to complete OAuth authorization.

### Delete Connection

```bash
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}', method='DELETE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
```

### Specifying Connection

If you have multiple CallRail connections, specify which one to use with the `Maton-Connection` header:

```bash
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/callrail/v3/a.json')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Maton-Connection', '{connection_id}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
```

If you have multiple connections, always include this header to ensure requests go to the intended account.

## Security & Permissions

- Access is scoped to calls, accounts, companies, trackers, and integrations within the connected CallRail account.
- **All write operations require explicit user approval.** Before executing any create, update, or delete call, confirm the target resource and intended effect with the user.

## API Reference

### URL Pattern

All CallRail API endpoints follow this pattern:

```
/callrail/v3/a/{account_id}/{resource}.json
```

Account IDs start with `ACC`, Company IDs start with `COM`, Call IDs start with `CAL`, Tracker IDs start with `TRK`, User IDs start with `USR`.

---

## Accounts

### List Accounts

```bash
GET /callrail/v3/a.json
```

**Response:**
```json
{
  "page": 1,
  "per_page": 100,
  "total_pages": 1,
  "total_records": 1,
  "accounts": [
    {
      "id": "ACC019c46b8a0807fbdb81c8bf12af91cb3",
      "name": "My Account",
      "numeric_id": 518664017,
      "inbound_recording_enabled": false,
      "outbound_recording_enabled": false,
      "hipaa_account": false,
      "created_at": "2026-02-10 03:43:50 -0500"
    }
  ]
}
```

### Get Account

```bash
GET /callrail/v3/a/{account_id}.json
```

---

## Companies

### List Companies

```bash
GET /callrail/v3/a/{account_id}/companies.json
```

**Response:**
```json
{
  "page": 1,
  "per_page": 100,
  "total_pages": 1,
  "total_records": 1,
  "companies": [
    {
      "id": "COM019c46b8a26376a9a4f29671dcdd49e9",
      "name": "My Company",
      "status": "active",
      "time_zone": "America/Los_Angeles",
      "created_at": "2026-02-10T08:43:51.280Z",
      "callscore_enabled": false,
      "lead_scoring_enabled": true,
      "callscribe_enabled": true
    }
  ]
}
```

### Get Company

```bash
GET /callrail/v3/a/{account_id}/companies/{company_id}.json
```

---

## Calls

### List Calls

```bash
GET /callrail/v3/a/{account_id}/calls.json
```

**Query Parameters:**

| Parameter | Description |
|-----------|-------------|
| `page` | Page number (default: 1) |
| `per_page` | Results per page (default: 100, max: 250) |
| `date_range` | Preset: `recent`, `today`, `yesterday`, `last_7_days`, `last_30_days`, `this_month`, `last_month` |
| `start_date` | ISO 8601 date (e.g., `2026-02-01T00:00:00-08:00`) |
| `end_date` | ISO 8601 date |
| `company_id` | Filter by company |
| `tracker_id` | Filter by tracker |
| `search` | Search term |
| `fields` | Comma-separated field names to return |
| `sort` | Field to sort by |
| `order` | Sort order: `asc` or `desc` |

**Response:**
```json
{
  "page": 1,
  "per_page": 100,
  "total_pages": 1,
  "total_records": 1,
  "calls": [
    {
      "id": "CAL019c46b9fc277a7881e3728fea20869b",
      "answered": false,
      "customer_name": "John Doe",
      "customer_phone_number": "+18886757190",
      "direction": "inbound",
      "duration": 36,
      "recording": "https://api.callrail.com/v3/a/.../recording",
      "recording_duration": 36,
      "start_time": "2026-02-10T00:45:19.781-08:00",
      "tracking_phone_number": "+18017846712",
      "voicemail": true
    }
  ]
}
```

### Get Call

```bash
GET /callrail/v3/a/{account_id}/calls/{call_id}.json
```

### Update Call

```bash
PUT /callrail/v3/a/{account_id}/calls/{call_id}.json
Content-Type: application/json

{
  "customer_name": "John Smith",
  "note": "Follow up scheduled",
  "lead_status": "good_lead",
  "spam": false
}
```

**Updatable Fields:**

| Field | Description |
|-------|-------------|
| `customer_name` | Customer's name |
| `note` | Call notes |
| `lead_status` | `good_lead`, `not_a_lead`, `previously_marked_good_lead` |
| `spam` | Mark as spam (boolean) |
| `tag_list` | Array of tag names to apply |
| `value` | Call value (numeric) |
| `append_tags` | Add tags without removing existing |

### Call Summary

```bash
GET /callrail/v3/a/{account_id}/calls/summary.json
```

Get aggregated call statistics for a date range.

**Query Parameters:**

| Parameter | Description |
|-----------|-------------|
| `date_range` | Preset date range |
| `start_date` | Start date (ISO 8601) |
| `end_date` | End date (ISO 8601) |
| `group_by` | Group results: `company`, `tracker`, `source`, `medium`, etc. |

**Response:**
```json
{
  "start_date": "2026-02-03T00:00:00-0800",
  "end_date": "2026-02-10T23:59:59-0800",
  "time_zone": "Pacific Time (US & Canada)",
  "total_results": {
    "total_calls": 42
  }
}
```

### Call Timeseries

```bash
GET /callrail/v3/a/{account_id}/calls/timeseries.json
```

Get call data over time for charts and graphs.

**Response:**
```json
{
  "start_date": "2026-02-03T00:00:00-0800",
  "end_date": "2026-02-10T23:59:59-0800",
  "data": [
    {"key": "2026-02-03", "date": "2026-02-03", "total_calls": 5},
    {"key": "2026-02-04", "date": "2026-02-04", "total_calls": 8}
  ]
}
```

---

## Trackers (Tracking Numbers)

### List Trackers

```bash
GET /callrail/v3/a/{account_id}/trackers.json
```

**Response:**
```json
{
  "page": 1,
  "per_page": 100,
  "total_records": 1,
  "trackers": [
    {
      "id": "TRK019c46b9f18174d68bb8d7985260a11f",
      "name": "Google My Business",
      "type": "source",
      "status": "active",
      "destination_number": "+18019234886",
      "tracking_numbers": ["+18017846712"],
      "sms_supported": true,
      "sms_enabled": true,
      "company": {
        "id": "COM019c46b8a26376a9a4f29671dcdd49e9",
        "name": "My Company"
      },
      "source": {"type": "google_my_business"},
      "call_flow": {
        "type": "basic",
        "recording_enabled": true,
        "destination_number": "+18019234886"
      }
    }
  ]
}
```

### Get Tracker

```bash
GET /callrail/v3/a/{account_id}/trackers/{tracker_id}.json
```

---

## Tags

### List Tags

```bash
GET /callrail/v3/a/{account_id}/tags.json
```

**Response:**
```json
{
  "page": 1,
  "per_page": 100,
  "total_records": 6,
  "tags": [
    {
      "id": 7886733,
      "name": "Schedule requested",
      "tag_level": "account",
      "color": "orange3",
      "background_color": "gray1",
      "company_id": null,
      "status": "enabled"
    },
    {
      "id": 7886728,
      "name": "Opportunity",
      "tag_level": "company",
      "color": "gray1",
      "company_id": "COM019c46b8a26376a9a4f29671dcdd49e9",
      "status": "enabled"
    }
  ]
}
```

### Create Tag

```bash
POST /callrail/v3/a/{account_id}/tags.json
Content-Type: application/json

{
  "name": "New Tag",
  "tag_level": "account",
  "color": "blue1"
}
```

**Tag Levels:**
- `account` - Available to all companies in the account
- `company` - Specific to a company (requires `company_id`)

**Colors:** `gray1`, `blue1`, `blue2`, `green1`, `green2`, `orange1`, `orange2`, `orange3`, `red1`, etc.

### Update Tag

```bash
PUT /callrail/v3/a/{account_id}/tags/{tag_id}.json
Content-Type: application/json

{
  "name": "Updated Tag Name",
  "color": "green1"
}
```

### Delete Tag

```bash
DELETE /callrail/v3/a/{account_id}/tags/{tag_id}.json
```

---

## Users

### List Users

```bash
GET /callrail/v3/a/{account_id}/users.json
```

**Response:**
```json
{
  "page": 1,
  "per_page": 100,
  "total_records": 1,
  "users": [
    {
      "id": "USR019c46b8a0557b2e85e5e1c651452509",
      "email": "user@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "name": "John Doe",
      "role": "admin",
      "accepted": true,
      "created_at": "2026-02-10T03:43:50.798-05:00",
      "companies": [
        {"id": "COM...", "name": "My Company"}
      ]
    }
  ]
}
```

### Get User

```bash
GET /callrail/v3/a/{account_id}/users/{user_id}.json
```

---

## Integrations

### List Integrations

```bash
GET /callrail/v3/a/{account_id}/integrations.json?company_id={company_id}
```

**Note:** `company_id` is required.

---

## Notifications

### List Notifications

```bash
GET /callrail/v3/a/{account_id}/notifications.json
```

---

## Pagination

CallRail uses offset-based pagination:

```bash
GET /callrail/v3/a/{account_id}/calls.json?page=2&per_page=50
```

**Response includes:**
```json
{
  "page": 2,
  "per_page": 50,
  "total_pages": 10,
  "total_records": 487,
  "calls": [...]
}
```

**Parameters:**
- `page` - Page number (default: 1)
- `per_page` - Results per page (default: 100, max: 250)

For the calls endpoint, you can also use relative pagination:

```bash
GET /callrail/v3/a/{account_id}/calls.json?relative_pagination=true
```

This returns `next_page` URL and `has_next_page` boolean for efficient pagination of large datasets.

## Code Examples

### JavaScript

```javascript
const response = await fetch(
  'https://api.maton.ai/callrail/v3/a/{account_id}/calls.json',
  {
    headers: {
      'Authorization': `Bearer ${process.env.MATON_API_KEY}`
    }
  }
);
const data = await response.json();
console.log(data.calls);
```

### Python

```python
import os
import requests

response = requests.get(
    'https://api.maton.ai/callrail/v3/a/{account_id}/calls.json',
    headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'},
    params={'per_page': 50, 'date_range': 'last_30_days'}
)
data = response.json()
for call in data['calls']:
    print(f"{call['customer_name']}: {call['duration']}s")
```

## Rate Limits

| Endpoint Type | Hourly Limit | Daily Limit |
|--------------|--------------|-------------|
| General API | 1,000 | 10,000 |
| SMS Send | 150 | 1,000 |
| Outbound Calls | 100 | 2,000 |

Exceeding limits returns HTTP 429. Implement exponential backoff for retries.

## Notes

- Account IDs start with `ACC`
- Company IDs start with `COM`
- Call IDs start with `CAL`
- Tracker IDs start with `TRK`
- User IDs start with `USR`
- All endpoints end with `.json`
- Communication records are retained for 25 months
- Date/time values use ISO 8601 format with timezone
- IMPORTANT: When using curl commands, use `curl -g` when URLs contain brackets to disable glob parsing
- IMPORTANT: When piping curl output to `jq` or other commands, environment variables like `$MATON_API_KEY` may not expand correctly in some shell environments

## Error Handling

| Status | Meaning |
|--------|---------|
| 400 | Bad request or missing required parameter |
| 401 | Invalid or missing Maton API key |
| 403 | Forbidden - insufficient permissions |
| 404 | Resource not found |
| 422 | Unprocessable entity |
| 429 | Rate limited |
| 500 | Internal server error |
| 503 | Service unavailable |

### Troubleshooting: API Key Issues

1. Check that the `MATON_API_KEY` environment variable is set:

```bash
echo $MATON_API_KEY
```

2. Verify the API key is valid by listing connections:

```bash
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
```

### Troubleshooting: Invalid App Name

1. Ensure your URL path starts with `callrail`. For example:

- Correct: `https://api.maton.ai/callrail/v3/a.json`
- Incorrect: `https://api.maton.ai/v3/a.json`

## Resources

- [CallRail API Documentation](https://apidocs.callrail.com/)
- [CallRail Help Center - API](https://support.callrail.com/hc/en-us/sections/4426797289229-API)
- [CallRail API Rate Limits](https://apidocs.callrail.com/#rate-limiting)
- [Maton Community](https://discord.com/invite/dBfFAcefs2)
- [Maton Support](mailto:support@maton.ai)