# CallRail

> Work with CallRail call tracking: list and read calls with their marketing source, tag and score leads, place calls, send texts, read form submissions and summary reports, and manage companies and tags. Start a workflow when a call comes in or ends, a text arrives or a form is submitted.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/callrail

## Actions

### Create company

Create a company in the account, such as for a new client or location. Add its tracking numbers in CallRail.

**Inputs**

- Name (`name`, text, required): The company's name.
- Time zone (`time_zone`, text): The company's time zone, such as America/New_York. Defaults to the account's.

**Outputs**

- `company` (object): The company

**Example output**

```json
{
  "company": {
    "callscore_enabled": false,
    "callscribe_enabled": false,
    "created_at": "2016-06-06T07:06:01.000Z",
    "disabled_at": null,
    "dni_active": true,
    "form_capture": true,
    "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "lead_scoring_enabled": true,
    "name": "Widget Shop",
    "premium_ci_enabled": false,
    "script_url": "//cdn.callrail.com/companies/183570817/5706dbe6dc972c634a65/12/swap.js",
    "status": "active",
    "swap_cookie_duration": 6,
    "swap_cookie_duration_unit": "months",
    "time_zone": "America/New_York"
  }
}
```

### Create tag

Create a tag for one company, or (as an admin) for every company in the account.

**Inputs**

- Name (`name`, text, required): The tag's name.
- Company (`company_id`, text): The company the tag is for. Needed unless the tag is for every company.
- Colour (`color`, text): The tag's colour in CallRail. One of: `gray1` (Gray 1), `gray2` (Gray 2), `blue1` (Blue 1), `blue2` (Blue 2), `cyan1` (Cyan 1), `cyan2` (Cyan 2), `purple1` (Purple 1), `purple2` (Purple 2), `pink1` (Pink 1), `pink2` (Pink 2), and 14 more.
- For (`tag_level`, text): One company (default), or every company in the account. One of: `company` (One company), `account` (Every company in the account). Default: `company`.

**Outputs**

- `tag` (object): The tag

**Example output**

```json
{
  "tag": {
    "background_color": "gray1",
    "color": "gray1",
    "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "created_at": "2017-07-24T11:13:47.366-04:00",
    "id": 993186,
    "name": "Existing Customer",
    "status": "enabled",
    "tag_level": "company"
  }
}
```

### Delete tag

Delete a tag. It is removed from every call, text and form submission that has it. To keep it on those, disable it with 'Update tag' instead.

**Inputs**

- Tag ID (`tag_id`, text, required): The tag's ID, from 'List tags' or 'Create tag'.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `tag_id` (text): The tag deleted

**Example output**

```json
{
  "deleted": true,
  "tag_id": "993186"
}
```

### Disable company

Disable a company. Its tracking numbers stop working and its website script turns off. An account's only company can't be disabled.

**Inputs**

- Company (`company_id`, text, required): The CallRail company. Pick one, or give its ID from an earlier step.

**Outputs**

- `company_id` (text): The company disabled
- `disabled` (true/false): Always true once done

**Example output**

```json
{
  "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
  "disabled": true
}
```

### Get call

Get one call with its caller, source and campaign, tags, note, lead status, recording, and its transcript and summary where the plan includes them.

**Inputs**

- Call ID (`call_id`, text, required): The call's ID (it starts with CAL), from 'List calls' or a trigger.

**Outputs**

- `call` (object): The call

**Example output**

```json
{
  "call": {
    "agent_email": "gil@example.com",
    "answered": true,
    "business_phone_number": "+14045556666",
    "call_summary": "The caller asked for a quote to repair two widgets.",
    "call_type": "answered",
    "campaign": "US_branded",
    "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "company_name": "Widget Shop",
    "created_at": "2026-11-03T11:27:48.119-05:00",
    "customer_city": "Denver",
    "customer_country": "US",
    "customer_name": "Jimmy Pesto",
    "customer_phone_number": "+13036231131",
    "customer_state": "CO",
    "direction": "inbound",
    "duration": 184,
    "first_call": true,
    "gclid": "12345abgdef",
    "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
    "keywords": "widget repair",
    "landing_page_url": "https://www.example.com/repair",
    "lead_score": "very good",
    "lead_status": "good_lead",
    "medium": "cpc",
    "milestones": {
      "first_touch": {
        "medium": "cpc",
        "source": "Google Ads"
      }
    },
    "note": "Wants a quote by Friday",
    "person_id": "PER8154748ae6bd4e278a7cddd38a662f4f",
    "recording": "https://api.callrail.com/v3/a/227799611/calls/111222333/recording.json",
    "recording_duration": "180",
    "recording_player": "https://app.callrail.com/calls/111222333/recording?access_key=3b91",
    "referring_url": "https://www.google.com/",
    "sentiment": "positive",
    "source": "Google Ads",
    "source_name": "Google Paid",
    "start_time": "2026-11-03T11:27:48.119-05:00",
    "tags": [
      {
        "color": "blue2",
        "name": "Sales"
      }
    ],
    "timeline_url": "https://app.callrail.com/a/227799611/timeline/PER8154",
    "tracker_id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
    "tracking_phone_number": "+13038163491",
    "transcription": "Agent: Thanks for calling Widget Shop...",
    "utm_campaign": "US_branded",
    "utm_medium": "cpc",
    "utm_source": "google",
    "value": "250.00",
    "voicemail": false
  }
}
```

### Get call recording

Get a link to a call's recording as an MP3, to play or save. Fails if the call wasn't recorded.

**Inputs**

- Call ID (`call_id`, text, required): The call's ID (it starts with CAL), from 'List calls' or a trigger.

**Outputs**

- `call_id` (text): The call
- `url` (text): A link to the MP3

**Example output**

```json
{
  "call_id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
  "url": "https://app.callrail.com/calls/CAL11df32690b7d46/recording/redirect?access_key=241sa242sadqwerty123"
}
```

### Get calls over time

Count calls for each hour, day, week, month or year of a date range, for a chart or a trend. At most 200 points: use a longer interval for a long range.

**Inputs**

- Company (`company_id`, text): Only this company. Leave empty for every company in the account.
- Interval (`interval`, text): How long each point covers. Defaults to a day. One of: `hour`, `day` (Day (default)), `week`, `month`, `year`.
- Date range (`date_range`, text): A named range. Ignored when a start or end date is given. Defaults to the last 7 days, including today. One of: `recent` (Last 7 days, including today (default)), `today`, `yesterday`, `last_7_days` (Last 7 days, not including today), `last_30_days` (Last 30 days, not including today), `this_month` (This month), `last_month` (Last month), `this_year` (This year), `last_year` (Last year), `all_time` (All time (the last 25 months)).
- From (`start_date`, date): Only from this date on (in the account's time zone).
- Until (`end_date`, date): Only up to and including this date.
- Totals (`fields`, list): Which totals to get. Defaults to total calls only. One or more of: `total_calls` (Total calls), `missed_calls` (Missed calls), `answered_calls` (Answered calls), `first_time_callers` (First-time callers), `average_duration` (Average length (seconds)), `formatted_average_duration` (Average length (formatted)), `leads`.
- Direction (`direction`, text): Only calls from customers (inbound) or to them (outbound). One of: `inbound`, `outbound`.
- Answered (`answer_status`, text): Only answered calls, missed calls or calls that went to voicemail. One of: `answered`, `missed`, `voicemail`.
- Device (`device`, text): Only callers who came from a desktop or a mobile website visit. One of: `desktop`, `mobile`.
- Lead status (`lead_status`, text): Only good leads, those marked not a lead, or those not scored yet. One of: `good_lead` (Good lead), `not_a_lead` (Not a lead), `not_scored` (Not scored).

**Outputs**

- `data` (list): One set of totals per interval, each with its 'date'
- `end_date` (text): End of the range reported
- `start_date` (text): Start of the range reported
- `time_zone` (text): The time zone of the dates
- `total_results` (object): The totals asked for, such as total_calls

**Example output**

```json
{
  "data": [
    {
      "date": "2026-10-01",
      "total_calls": 30
    },
    {
      "date": "2026-10-02",
      "total_calls": 20
    }
  ],
  "end_date": "2026-10-02T23:59:59-0400",
  "start_date": "2026-10-01T00:00:00-0400",
  "time_zone": "America/New_York",
  "total_results": {
    "total_calls": 50
  }
}
```

### Get company

Get one company with its time zone, status and tracking settings.

**Inputs**

- Company (`company_id`, text, required): The CallRail company. Pick one, or give its ID from an earlier step.

**Outputs**

- `company` (object): The company

**Example output**

```json
{
  "company": {
    "callscore_enabled": false,
    "callscribe_enabled": false,
    "created_at": "2016-06-06T07:06:01.000Z",
    "disabled_at": null,
    "dni_active": true,
    "form_capture": true,
    "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "lead_scoring_enabled": true,
    "name": "Widget Shop",
    "premium_ci_enabled": false,
    "script_url": "//cdn.callrail.com/companies/183570817/5706dbe6dc972c634a65/12/swap.js",
    "status": "active",
    "swap_cookie_duration": 6,
    "swap_cookie_duration_unit": "months",
    "time_zone": "America/New_York"
  }
}
```

### Get text conversation

Get one text conversation with its messages, the newest first.

**Inputs**

- Conversation ID (`conversation_id`, text, required): The conversation's ID, from 'List text conversations' or a text trigger.

**Outputs**

- `conversation` (object): The conversation
- `messages` (list): Its messages, newest first

**Example output**

```json
{
  "conversation": {
    "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "company_time_zone": "America/New_York",
    "current_tracker_id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
    "current_tracking_number": "+14045556677",
    "customer_name": "Kevin Mann",
    "customer_phone_number": "+14042223333",
    "id": "KZaGR",
    "initial_tracker_id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
    "initial_tracking_number": "+14045556677",
    "last_message_at": "2026-11-03T19:28:21.578Z",
    "lead_status": null,
    "recent_messages": [
      {
        "content": "Thanks, we can come by on Tuesday.",
        "created_at": "2026-11-03T19:28:21.578Z",
        "direction": "outgoing",
        "media_urls": [],
        "type": "sms"
      },
      {
        "content": "Can someone look at my widget this week?",
        "created_at": "2026-11-03T19:26:43.578Z",
        "direction": "incoming",
        "media_urls": [],
        "type": "sms"
      }
    ],
    "source": "Google Organic",
    "state": "active"
  },
  "messages": [
    {
      "content": "Can someone look at my widget this week?",
      "created_at": "2026-11-03T19:26:43.578Z",
      "direction": "incoming",
      "id": 23456,
      "media_urls": [],
      "status": null,
      "type": "sms",
      "user": null
    }
  ]
}
```

### Get tracking number

Get one tracker with its numbers, where calls ring, the source it tracks and whether it can text.

**Inputs**

- Tracking number (`tracker_id`, text, required): The tracker. Pick one, or give its ID (it starts with TRK).

**Outputs**

- `tracker` (object): The tracker

**Example output**

```json
{
  "tracker": {
    "call_flow": {
      "recording_enabled": true,
      "type": "basic"
    },
    "campaign_name": "Billboard",
    "company": {
      "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
      "name": "Widget Shop"
    },
    "created_at": "2011-07-05T19:06:10Z",
    "destination_number": "+15553104554",
    "disabled_at": null,
    "id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
    "name": "My Billboard",
    "sms_enabled": true,
    "sms_supported": true,
    "source": {
      "type": "offline"
    },
    "status": "active",
    "tracking_numbers": [
      "+14045559999"
    ],
    "type": "source",
    "whisper_message": null
  }
}
```

### List calls

List calls, newest first, with the caller, the marketing source and campaign, tags, note and lead status. Filter by company, tracking number, dates, direction, answer, lead status or tag. Gets one page; run it again with the next page to see more.

**Inputs**

- Company (`company_id`, text): Only this company. Leave empty for every company in the account.
- Tracking number (`tracker_id`, text): Only calls to this tracking number.
- Date range (`date_range`, text): A named range. Ignored when a start or end date is given. Defaults to the last 7 days, including today. One of: `recent` (Last 7 days, including today (default)), `today`, `yesterday`, `last_7_days` (Last 7 days, not including today), `last_30_days` (Last 30 days, not including today), `this_month` (This month), `last_month` (Last month), `this_year` (This year), `last_year` (Last year), `all_time` (All time (the last 25 months)).
- From (`start_date`, date): Only from this date on (in the account's time zone).
- Until (`end_date`, date): Only up to and including this date.
- Direction (`direction`, text): Only calls from customers (inbound) or to them (outbound). One of: `inbound`, `outbound`.
- Answered (`answer_status`, text): Only answered calls, missed calls or calls that went to voicemail. One of: `answered`, `missed`, `voicemail`.
- Lead status (`lead_status`, text): Only good leads, those marked not a lead, or those not scored yet. One of: `good_lead` (Good lead), `not_a_lead` (Not a lead), `not_scored` (Not scored).
- Device (`device`, text): Only callers who came from a desktop or a mobile website visit. One of: `desktop`, `mobile`.
- Tags (`tags`, list): Only those with any of these tags, by name.
- Search (`search`, text): Only calls whose caller's name or number, note or source contains this.
- Page (`page`, number): Which page to get, starting at 1. Defaults to the first. At least 1.
- Page size (`per_page`, number): How many to get, 1 to 250. CallRail's default is 100. From 1 to 250.

**Outputs**

- `calls` (list): The calls
- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is a next page (run again with page + 1)
- `page` (number): This page's number
- `total_pages` (number): How many pages there are
- `total_records` (number): How many there are in all

**Example output**

```json
{
  "calls": [
    {
      "agent_email": "gil@example.com",
      "answered": true,
      "business_phone_number": "+14045556666",
      "call_type": "answered",
      "campaign": "US_branded",
      "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
      "company_name": "Widget Shop",
      "created_at": "2026-11-03T11:27:48.119-05:00",
      "customer_city": "Denver",
      "customer_country": "US",
      "customer_name": "Jimmy Pesto",
      "customer_phone_number": "+13036231131",
      "customer_state": "CO",
      "direction": "inbound",
      "duration": 184,
      "first_call": true,
      "gclid": "12345abgdef",
      "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
      "keywords": "widget repair",
      "landing_page_url": "https://www.example.com/repair",
      "lead_status": "good_lead",
      "medium": "cpc",
      "note": "Wants a quote by Friday",
      "person_id": "PER8154748ae6bd4e278a7cddd38a662f4f",
      "recording": "https://api.callrail.com/v3/a/227799611/calls/111222333/recording.json",
      "recording_duration": "180",
      "recording_player": "https://app.callrail.com/calls/111222333/recording?access_key=3b91",
      "referring_url": "https://www.google.com/",
      "source": "Google Ads",
      "source_name": "Google Paid",
      "start_time": "2026-11-03T11:27:48.119-05:00",
      "tags": [
        {
          "color": "blue2",
          "name": "Sales"
        }
      ],
      "timeline_url": "https://app.callrail.com/a/227799611/timeline/PER8154",
      "tracker_id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
      "tracking_phone_number": "+13038163491",
      "utm_campaign": "US_branded",
      "utm_medium": "cpc",
      "utm_source": "google",
      "value": "250.00",
      "voicemail": false
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_pages": 1,
  "total_records": 1
}
```

### List companies

List the companies in the account, each with its own tracking numbers and settings (an agency has one per client). Gets one page; run it again with the next page to see more.

**Inputs**

- Status (`status`, text): Only active or only disabled companies. One of: `active`, `disabled`.
- Search (`search`, text): Only companies whose name contains this.
- Page (`page`, number): Which page to get, starting at 1. Defaults to the first. At least 1.
- Page size (`per_page`, number): How many to get, 1 to 250. CallRail's default is 100. From 1 to 250.

**Outputs**

- `companies` (list): The companies
- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is a next page (run again with page + 1)
- `page` (number): This page's number
- `total_pages` (number): How many pages there are
- `total_records` (number): How many there are in all

**Example output**

```json
{
  "companies": [
    {
      "callscore_enabled": false,
      "callscribe_enabled": false,
      "created_at": "2016-06-06T07:06:01.000Z",
      "disabled_at": null,
      "dni_active": true,
      "form_capture": true,
      "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
      "lead_scoring_enabled": true,
      "name": "Widget Shop",
      "premium_ci_enabled": false,
      "script_url": "//cdn.callrail.com/companies/183570817/5706dbe6dc972c634a65/12/swap.js",
      "status": "active",
      "swap_cookie_duration": 6,
      "swap_cookie_duration_unit": "months",
      "time_zone": "America/New_York"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_pages": 1,
  "total_records": 1
}
```

### List form submissions

List the website form submissions CallRail captured, newest first, with what was filled in and the marketing source. Gets one page; run it again with the next page to see more.

**Inputs**

- Company (`company_id`, text): Only this company. Leave empty for every company in the account.
- Date range (`date_range`, text): A named range. Ignored when a start or end date is given. Defaults to the last 7 days, including today. One of: `recent` (Last 7 days, including today (default)), `today`, `yesterday`, `last_7_days` (Last 7 days, not including today), `last_30_days` (Last 30 days, not including today), `this_month` (This month), `last_month` (Last month), `this_year` (This year), `last_year` (Last year), `all_time` (All time (the last 25 months)).
- From (`start_date`, date): Only from this date on (in the account's time zone).
- Until (`end_date`, date): Only up to and including this date.
- Lead status (`lead_status`, text): Only good leads, those marked not a lead, or those not scored yet. One of: `good_lead` (Good lead), `not_a_lead` (Not a lead), `not_scored` (Not scored).
- Tags (`tags`, list): Only those with any of these tags, by name.
- Page (`page`, number): Which page to get, starting at 1. Defaults to the first. At least 1.
- Page size (`per_page`, number): How many to get, 1 to 250. CallRail's default is 100. From 1 to 250.

**Outputs**

- `count` (number): How many are on this page
- `form_submissions` (list): The submissions
- `has_more` (true/false): Whether there is a next page (run again with page + 1)
- `page` (number): This page's number
- `total_pages` (number): How many pages there are
- `total_records` (number): How many there are in all

**Example output**

```json
{
  "count": 1,
  "form_submissions": [
    {
      "campaign": "back_to_school",
      "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
      "company_name": "Widget Shop",
      "customer_email": "graham@example.com",
      "customer_name": "Graham Armstrong",
      "customer_phone_number": "+19999999999",
      "first_form": true,
      "form_data": {
        "email": "graham@example.com",
        "name": "Graham Armstrong"
      },
      "form_name": "Appointment request",
      "form_url": "https://www.example.com/appointment",
      "id": "FOR8154748ae6bd4e278a7cddd38a662f4f",
      "keywords": "widget repair",
      "landing_page_url": "https://www.example.com/appointment?campaign=back_to_school",
      "lead_status": null,
      "medium": "CPC",
      "note": null,
      "person_id": "PER8154748ae6bd4e278a7cddd38a662f4f",
      "referrer": "google_paid",
      "referring_url": "https://www.google.com/",
      "source": "Google Ads",
      "submitted_at": "2026-11-03T07:46:28.000Z",
      "tags": [],
      "timeline_url": "https://app.callrail.com/a/227799611/timeline/PER8154",
      "utm_campaign": "back_to_school",
      "utm_medium": "cpc",
      "utm_source": "google",
      "value": null
    }
  ],
  "has_more": false,
  "page": 1,
  "total_pages": 1,
  "total_records": 1
}
```

### List tags

List the tags that label calls, texts and form submissions, in one company or across the account. Gets one page; run it again with the next page to see more.

**Inputs**

- Company (`company_id`, text): Only this company's tags.
- Status (`status`, text): Only enabled or only disabled tags. One of: `enabled`, `disabled`.
- Level (`tag_level`, text): Only tags for one company, or only those for every company in the account. One of: `company` (One company), `account` (Every company in the account).
- Page (`page`, number): Which page to get, starting at 1. Defaults to the first. At least 1.
- Page size (`per_page`, number): How many to get, 1 to 250. CallRail's default is 100. From 1 to 250.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is a next page (run again with page + 1)
- `page` (number): This page's number
- `tags` (list): The tags
- `total_pages` (number): How many pages there are
- `total_records` (number): How many there are in all

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "tags": [
    {
      "background_color": "gray1",
      "color": "gray1",
      "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
      "created_at": "2017-07-24T11:13:47.366-04:00",
      "id": 993186,
      "name": "Existing Customer",
      "status": "enabled",
      "tag_level": "company"
    }
  ],
  "total_pages": 1,
  "total_records": 1
}
```

### List text conversations

List text message conversations with customers, the most recent first, each with its last two messages. Gets one page; run it again with the next page to see more.

**Inputs**

- Company (`company_id`, text): Only this company. Leave empty for every company in the account.
- Date range (`date_range`, text): A named range. Ignored when a start or end date is given. Defaults to the last 7 days, including today. One of: `recent` (Last 7 days, including today (default)), `today`, `yesterday`, `last_7_days` (Last 7 days, not including today), `last_30_days` (Last 30 days, not including today), `this_month` (This month), `last_month` (Last month), `this_year` (This year), `last_year` (Last year), `all_time` (All time (the last 25 months)).
- From (`start_date`, date): Only from this date on (in the account's time zone).
- Until (`end_date`, date): Only up to and including this date.
- Search (`search`, text): Only conversations with this customer name or number.
- Page (`page`, number): Which page to get, starting at 1. Defaults to the first. At least 1.
- Page size (`per_page`, number): How many to get, 1 to 250. CallRail's default is 100. From 1 to 250.

**Outputs**

- `conversations` (list): The conversations
- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is a next page (run again with page + 1)
- `page` (number): This page's number
- `total_pages` (number): How many pages there are
- `total_records` (number): How many there are in all

**Example output**

```json
{
  "conversations": [
    {
      "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
      "company_time_zone": "America/New_York",
      "current_tracker_id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
      "current_tracking_number": "+14045556677",
      "customer_name": "Kevin Mann",
      "customer_phone_number": "+14042223333",
      "id": "KZaGR",
      "initial_tracker_id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
      "initial_tracking_number": "+14045556677",
      "last_message_at": "2026-11-03T19:28:21.578Z",
      "lead_status": null,
      "recent_messages": [
        {
          "content": "Thanks, we can come by on Tuesday.",
          "created_at": "2026-11-03T19:28:21.578Z",
          "direction": "outgoing",
          "media_urls": [],
          "type": "sms"
        },
        {
          "content": "Can someone look at my widget this week?",
          "created_at": "2026-11-03T19:26:43.578Z",
          "direction": "incoming",
          "media_urls": [],
          "type": "sms"
        }
      ],
      "source": "Google Organic",
      "state": "active"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_pages": 1,
  "total_records": 1
}
```

### List tracking numbers

List tracking numbers (CallRail calls them trackers) with the numbers, where calls ring and the source each tracks. Gets one page; run it again with the next page to see more.

**Inputs**

- Company (`company_id`, text): Only this company. Leave empty for every company in the account.
- Type (`tracker_type`, text): Only source trackers or only website session pools. One of: `source` (Source (one number per marketing source)), `session` (Website session (a pool of numbers)).
- Status (`status`, text): Only active or only disabled tracking numbers. One of: `active`, `disabled`.
- Search (`search`, text): Only tracking numbers whose name contains this.
- Page (`page`, number): Which page to get, starting at 1. Defaults to the first. At least 1.
- Page size (`per_page`, number): How many to get, 1 to 250. CallRail's default is 100. From 1 to 250.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is a next page (run again with page + 1)
- `page` (number): This page's number
- `total_pages` (number): How many pages there are
- `total_records` (number): How many there are in all
- `trackers` (list): The tracking numbers

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_pages": 1,
  "total_records": 1,
  "trackers": [
    {
      "call_flow": {
        "recording_enabled": true,
        "type": "basic"
      },
      "campaign_name": "Billboard",
      "company": {
        "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
        "name": "Widget Shop"
      },
      "created_at": "2011-07-05T19:06:10Z",
      "destination_number": "+15553104554",
      "disabled_at": null,
      "id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
      "name": "My Billboard",
      "sms_enabled": true,
      "sms_supported": true,
      "source": {
        "type": "offline"
      },
      "status": "active",
      "tracking_numbers": [
        "+14045559999"
      ],
      "type": "source",
      "whisper_message": null
    }
  ]
}
```

### List users

List the people in the CallRail account with their role and the companies they can see. Gets one page; run it again with the next page to see more.

**Inputs**

- Company (`company_id`, text): Only people who can see this company.
- Search (`search`, text): Only people whose name or email contains this.
- Page (`page`, number): Which page to get, starting at 1. Defaults to the first. At least 1.
- Page size (`per_page`, number): How many to get, 1 to 250. CallRail's default is 100. From 1 to 250.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is a next page (run again with page + 1)
- `page` (number): This page's number
- `total_pages` (number): How many pages there are
- `total_records` (number): How many there are in all
- `users` (list): The users

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_pages": 1,
  "total_records": 1,
  "users": [
    {
      "accepted": true,
      "companies": [
        {
          "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
          "name": "Widget Shop"
        }
      ],
      "created_at": "2011-04-06T16:38:27.505-04:00",
      "email": "kevin@example.com",
      "first_name": "Kevin",
      "id": "USR8154748ae6bd4e278a7cddd38a662f4f",
      "last_name": "Mann",
      "name": "Kevin Mann",
      "role": "admin"
    }
  ]
}
```

### Place outbound call

Call a customer through CallRail: it rings your business number first and, once answered, dials the customer, showing your tracking number. US and Canadian numbers only.

**Inputs**

- Show as (`caller_id`, text, required): The tracking number (or verified caller ID) the customer sees calling them.
- Business phone (`business_phone_number`, text, required): The phone that rings first, such as your desk or mobile.
- Customer phone (`customer_phone_number`, text, required): The customer's number, such as (404) 555-1234.
- Record the call (`recording_enabled`, true/false): Record the call. Make sure the customer is told. Default: `false`.
- Greeting (`outbound_greeting_text`, text): Words read to the customer when they answer.
- Agent (`agent_id`, text): The CallRail user the call is assigned to.

**Outputs**

- `call` (object): The call

**Example output**

```json
{
  "call": {
    "agent_email": "gil@example.com",
    "answered": null,
    "business_phone_number": "+14045556666",
    "call_type": "outbound",
    "campaign": "US_branded",
    "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "company_name": "Widget Shop",
    "created_at": "2026-11-03T11:27:48.119-05:00",
    "customer_city": "Denver",
    "customer_country": "US",
    "customer_name": "Jimmy Pesto",
    "customer_phone_number": "+13036231131",
    "customer_state": "CO",
    "direction": "outbound",
    "duration": null,
    "first_call": true,
    "gclid": "12345abgdef",
    "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
    "keywords": "widget repair",
    "landing_page_url": "https://www.example.com/repair",
    "lead_status": "good_lead",
    "medium": "cpc",
    "note": "Wants a quote by Friday",
    "person_id": "PER8154748ae6bd4e278a7cddd38a662f4f",
    "recording": "https://api.callrail.com/v3/a/227799611/calls/111222333/recording.json",
    "recording_duration": "180",
    "recording_player": "https://app.callrail.com/calls/111222333/recording?access_key=3b91",
    "referring_url": "https://www.google.com/",
    "source": "Google Ads",
    "source_name": "Google Paid",
    "start_time": "2026-11-03T11:27:48.119-05:00",
    "tags": [
      {
        "color": "blue2",
        "name": "Sales"
      }
    ],
    "timeline_url": "https://app.callrail.com/a/227799611/timeline/PER8154",
    "tracker_id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
    "tracking_phone_number": "+13038163491",
    "utm_campaign": "US_branded",
    "utm_medium": "cpc",
    "utm_source": "google",
    "value": "250.00",
    "voicemail": false
  }
}
```

### Send text message

Text a customer from one of a company's text-enabled tracking numbers, one to one (CallRail forbids bulk texting). US and Canadian numbers only; the number must be registered for texting.

**Inputs**

- Company (`company_id`, text, required): The CallRail company. Pick one, or give its ID from an earlier step.
- From (`tracking_number`, text, required): The company's tracking number to text from.
- To (`customer_phone_number`, text, required): The customer's mobile number, such as (404) 555-1234.
- Message (`content`, text, required): The text. The first text to someone gets opt-out words (such as Reply STOP) added unless it has them.
- Picture link (`media_url`, text): A public https:// link to an image to send with it, as a picture message.

**Outputs**

- `conversation` (object): The text conversation

**Example output**

```json
{
  "conversation": {
    "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "company_time_zone": "America/New_York",
    "current_tracker_id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
    "current_tracking_number": "+14045556677",
    "customer_name": "Kevin Mann",
    "customer_phone_number": "+14042223333",
    "id": "KZaGR",
    "initial_tracker_id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
    "initial_tracking_number": "+14045556677",
    "last_message_at": "2026-11-03T19:28:21.578Z",
    "lead_status": null,
    "recent_messages": [
      {
        "content": "Thanks, we can come by on Tuesday.",
        "created_at": "2026-11-03T19:28:21.578Z",
        "direction": "outgoing",
        "media_urls": [],
        "type": "sms"
      },
      {
        "content": "Can someone look at my widget this week?",
        "created_at": "2026-11-03T19:26:43.578Z",
        "direction": "incoming",
        "media_urls": [],
        "type": "sms"
      }
    ],
    "source": "Google Organic",
    "state": "active"
  }
}
```

### Summarize calls

Count calls over a date range (total, missed, answered, first-time callers, leads, average length), overall and grouped by source, campaign, keyword, referrer, landing page or company.

**Inputs**

- Company (`company_id`, text): Only this company. Leave empty for every company in the account.
- Group by (`group_by`, text): Totals for each source, campaign and so on. One of: `source`, `keywords`, `campaign`, `referrer`, `landing_page` (Landing page), `company`.
- Date range (`date_range`, text): A named range. Ignored when a start or end date is given. Defaults to the last 7 days, including today. One of: `recent` (Last 7 days, including today (default)), `today`, `yesterday`, `last_7_days` (Last 7 days, not including today), `last_30_days` (Last 30 days, not including today), `this_month` (This month), `last_month` (Last month), `this_year` (This year), `last_year` (Last year), `all_time` (All time (the last 25 months)).
- From (`start_date`, date): Only from this date on (in the account's time zone).
- Until (`end_date`, date): Only up to and including this date.
- Totals (`fields`, list): Which totals to get. Defaults to total calls only. One or more of: `total_calls` (Total calls), `missed_calls` (Missed calls), `answered_calls` (Answered calls), `first_time_callers` (First-time callers), `average_duration` (Average length (seconds)), `formatted_average_duration` (Average length (formatted)), `leads`.
- Direction (`direction`, text): Only calls from customers (inbound) or to them (outbound). One of: `inbound`, `outbound`.
- Answered (`answer_status`, text): Only answered calls, missed calls or calls that went to voicemail. One of: `answered`, `missed`, `voicemail`.
- Device (`device`, text): Only callers who came from a desktop or a mobile website visit. One of: `desktop`, `mobile`.
- Lead status (`lead_status`, text): Only good leads, those marked not a lead, or those not scored yet. One of: `good_lead` (Good lead), `not_a_lead` (Not a lead), `not_scored` (Not scored).

**Outputs**

- `end_date` (text): End of the range reported
- `grouped_by` (text): What the results are grouped by
- `grouped_results` (list): One set of totals per group, each with its 'key' (a source, say)
- `start_date` (text): Start of the range reported
- `time_zone` (text): The time zone of the dates
- `total_results` (object): The totals asked for, such as total_calls

**Example output**

```json
{
  "end_date": "2026-10-31T23:59:59-0400",
  "grouped_by": "source",
  "grouped_results": [
    {
      "key": "Google Ads",
      "total_calls": 130
    },
    {
      "key": "Billboard Ad",
      "total_calls": 30
    }
  ],
  "start_date": "2026-10-01T00:00:00-0400",
  "time_zone": "America/New_York",
  "total_results": {
    "total_calls": 160
  }
}
```

### Summarize form submissions

Count form submissions over a date range (total, first-time, leads), overall and grouped by source, campaign, keyword, referrer, landing page or form.

**Inputs**

- Company (`company_id`, text): Only this company. Leave empty for every company in the account.
- Group by (`group_by`, text): Totals for each source, form and so on. One of: `source`, `keywords`, `campaign`, `referrer`, `landing_page` (Landing page), `form_name` (Form name).
- Date range (`date_range`, text): A named range. Ignored when a start or end date is given. Defaults to the last 7 days, including today. One of: `recent` (Last 7 days, including today (default)), `today`, `yesterday`, `last_7_days` (Last 7 days, not including today), `last_30_days` (Last 30 days, not including today), `this_month` (This month), `last_month` (Last month), `this_year` (This year), `last_year` (Last year), `all_time` (All time (the last 25 months)).
- From (`start_date`, date): Only from this date on (in the account's time zone).
- Until (`end_date`, date): Only up to and including this date.
- Totals (`fields`, list): Which totals to get. Defaults to total form submissions only. One or more of: `total_forms` (Total form submissions), `first_forms` (First-time submissions), `leads`.
- Lead status (`lead_status`, text): Only good leads, those marked not a lead, or those not scored yet. One of: `good_lead` (Good lead), `not_a_lead` (Not a lead), `not_scored` (Not scored).

**Outputs**

- `end_date` (text): End of the range reported
- `grouped_by` (text): What the results are grouped by
- `grouped_results` (list): One set of totals per group, each with its 'key' (a source, say)
- `start_date` (text): Start of the range reported
- `time_zone` (text): The time zone of the dates
- `total_results` (object): The totals asked for, such as total_calls

**Example output**

```json
{
  "end_date": "2026-10-31T23:59:59-0400",
  "grouped_by": "source",
  "grouped_results": [
    {
      "first_forms": 15,
      "key": "direct",
      "total_forms": 130
    },
    {
      "first_forms": 4,
      "key": "google_paid",
      "total_forms": 30
    }
  ],
  "start_date": "2026-10-01T00:00:00-0400",
  "time_zone": "America/New_York",
  "total_results": {
    "first_forms": 19,
    "leads": 46,
    "total_forms": 160
  }
}
```

### Update call

Add a note or tags to a call, score it as a good lead or not a lead, set what it was worth, or change the caller's name. Only the fields given change.

**Inputs**

- Call ID (`call_id`, text, required): The call's ID (it starts with CAL), from 'List calls' or a trigger.
- Note (`note`, text): A note to keep on the call. It replaces any note already there.
- Tags (`tags`, list): Tag names to add to the call. A tag the company doesn't have yet is created.
- Replace existing tags (`replace_tags`, true/false): Off (default): the tags are added to the ones already there. On: they replace them. Default: `false`.
- Lead status (`lead_status`, text): Score it as a good lead or not a lead. One of: `good_lead` (Good lead), `not_a_lead` (Not a lead).
- Value (`value`, text): What the call is worth, such as 125.00.
- Caller name (`customer_name`, text): The caller's name, replacing the caller ID name.

**Outputs**

- `call` (object): The call

**Example output**

```json
{
  "call": {
    "agent_email": "gil@example.com",
    "answered": true,
    "business_phone_number": "+14045556666",
    "call_type": "answered",
    "campaign": "US_branded",
    "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "company_name": "Widget Shop",
    "created_at": "2026-11-03T11:27:48.119-05:00",
    "customer_city": "Denver",
    "customer_country": "US",
    "customer_name": "Jimmy Pesto",
    "customer_phone_number": "+13036231131",
    "customer_state": "CO",
    "direction": "inbound",
    "duration": 184,
    "first_call": true,
    "gclid": "12345abgdef",
    "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
    "keywords": "widget repair",
    "landing_page_url": "https://www.example.com/repair",
    "lead_status": "good_lead",
    "medium": "cpc",
    "note": "Wants a quote by Friday",
    "person_id": "PER8154748ae6bd4e278a7cddd38a662f4f",
    "recording": "https://api.callrail.com/v3/a/227799611/calls/111222333/recording.json",
    "recording_duration": "180",
    "recording_player": "https://app.callrail.com/calls/111222333/recording?access_key=3b91",
    "referring_url": "https://www.google.com/",
    "source": "Google Ads",
    "source_name": "Google Paid",
    "start_time": "2026-11-03T11:27:48.119-05:00",
    "tags": [
      {
        "color": "blue2",
        "name": "Sales"
      }
    ],
    "timeline_url": "https://app.callrail.com/a/227799611/timeline/PER8154",
    "tracker_id": "TRK8154748ae6bd4e278a7cddd38a662f4f",
    "tracking_phone_number": "+13038163491",
    "utm_campaign": "US_branded",
    "utm_medium": "cpc",
    "utm_source": "google",
    "value": "250.00",
    "voicemail": false
  }
}
```

### Update company

Rename a company, change its time zone, or turn its call transcripts or call scoring on or off. Only the fields given change.

**Inputs**

- Company (`company_id`, text, required): The CallRail company. Pick one, or give its ID from an earlier step.
- Name (`name`, text): A new name. Leave empty to keep it.
- Time zone (`time_zone`, text): A new time zone, such as America/Chicago. Leave empty to keep it.
- Transcripts and call highlights (`callscribe`, text): Turn CallRail's call transcripts on or off. One of: `on`, `off`.
- Call scoring (`callscore`, text): Turn CallRail's call scoring (CallScore) on or off. One of: `on`, `off`.

**Outputs**

- `company` (object): The company

**Example output**

```json
{
  "company": {
    "callscore_enabled": false,
    "callscribe_enabled": false,
    "created_at": "2016-06-06T07:06:01.000Z",
    "disabled_at": null,
    "dni_active": true,
    "form_capture": true,
    "id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "lead_scoring_enabled": true,
    "name": "Widget Shop Downtown",
    "premium_ci_enabled": false,
    "script_url": "//cdn.callrail.com/companies/183570817/5706dbe6dc972c634a65/12/swap.js",
    "status": "active",
    "swap_cookie_duration": 6,
    "swap_cookie_duration_unit": "months",
    "time_zone": "America/New_York"
  }
}
```

### Update form submission

Add a note or tags to a form submission, score it as a good lead or not a lead, or set what it was worth. Only the fields given change.

**Inputs**

- Form submission ID (`form_submission_id`, text, required): The submission's ID (it starts with FOR), from 'List form submissions' or a trigger.
- Note (`note`, text): A note to keep on the form submission. It replaces any note already there.
- Tags (`tags`, list): Tag names to add to the form submission. A tag the company doesn't have yet is created.
- Replace existing tags (`replace_tags`, true/false): Off (default): the tags are added to the ones already there. On: they replace them. Default: `false`.
- Lead status (`lead_status`, text): Score it as a good lead or not a lead. One of: `good_lead` (Good lead), `not_a_lead` (Not a lead).
- Value (`value`, text): What the form submission is worth, such as 125.00.

**Outputs**

- `form_submission` (object): The submission

**Example output**

```json
{
  "form_submission": {
    "campaign": "back_to_school",
    "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "company_name": "Widget Shop",
    "customer_email": "graham@example.com",
    "customer_name": "Graham Armstrong",
    "customer_phone_number": "+19999999999",
    "first_form": true,
    "form_data": {
      "email": "graham@example.com",
      "name": "Graham Armstrong"
    },
    "form_name": "Appointment request",
    "form_url": "https://www.example.com/appointment",
    "id": "FOR8154748ae6bd4e278a7cddd38a662f4f",
    "keywords": "widget repair",
    "landing_page_url": "https://www.example.com/appointment?campaign=back_to_school",
    "lead_status": null,
    "medium": "CPC",
    "note": null,
    "person_id": "PER8154748ae6bd4e278a7cddd38a662f4f",
    "referrer": "google_paid",
    "referring_url": "https://www.google.com/",
    "source": "Google Ads",
    "submitted_at": "2026-11-03T07:46:28.000Z",
    "tags": [],
    "timeline_url": "https://app.callrail.com/a/227799611/timeline/PER8154",
    "utm_campaign": "back_to_school",
    "utm_medium": "cpc",
    "utm_source": "google",
    "value": null
  }
}
```

### Update tag

Rename a tag, change its colour, or disable it so it can't be added any more (it stays where it is). A new name shows everywhere the tag is.

**Inputs**

- Tag ID (`tag_id`, text, required): The tag's ID, from 'List tags' or 'Create tag'.
- Name (`name`, text): A new name. Leave empty to keep it.
- Colour (`color`, text): The tag's colour in CallRail. One of: `gray1` (Gray 1), `gray2` (Gray 2), `blue1` (Blue 1), `blue2` (Blue 2), `cyan1` (Cyan 1), `cyan2` (Cyan 2), `purple1` (Purple 1), `purple2` (Purple 2), `pink1` (Pink 1), `pink2` (Pink 2), and 14 more.
- Status (`status`, text): Enable the tag, or disable it for new calls and texts. One of: `enabled`, `disabled`.

**Outputs**

- `tag` (object): The tag

**Example output**

```json
{
  "tag": {
    "background_color": "gray1",
    "color": "gray1",
    "company_id": "COM8154748ae6bd4e278a7cddd38a662f4f",
    "created_at": "2017-07-24T11:13:47.366-04:00",
    "id": 993186,
    "name": "Returning Customer",
    "status": "enabled",
    "tag_level": "company"
  }
}
```
