| Area | Endpoints |
|---|---|
| Account | GET /me, GET /balance |
| Employees | GET /employees, GET /employees/{employee_id} |
| Phone numbers | GET /phone-numbers, GET /phone-numbers/{number_id} |
| Calls | GET /calls, POST /calls, GET /calls/{call_id}, POST /calls/{call_id}/cancel |
| Leads | GET /leads, GET /leads/{lead_id} |
| Campaigns | GET /campaigns, POST /campaigns, GET /campaigns/{campaign_id}, GET /campaigns/{campaign_id}/contacts, POST /campaigns/{campaign_id}/launch, POST /campaigns/{campaign_id}/pause, POST /campaigns/{campaign_id}/resume, POST /campaigns/{campaign_id}/stop |
| Contacts | GET /contacts, POST /contacts, GET /contacts/{contact_id}, PATCH /contacts/{contact_id}, DELETE /contacts/{contact_id}, GET /contact-fields |
| Appointments | GET /appointments, GET /appointments/{appointment_id} |
| Do-not-call | GET /dnc, POST /dnc, DELETE /dnc/{phone} |
| Webhooks | GET /webhook-endpoints, POST /webhook-endpoints, GET /webhook-endpoints/{endpoint_id}, PATCH /webhook-endpoints/{endpoint_id}, DELETE /webhook-endpoints/{endpoint_id}, POST /webhook-endpoints/{endpoint_id}/rotate-secret, POST /webhook-endpoints/{endpoint_id}/test, GET /webhook-endpoints/{endpoint_id}/deliveries, POST /webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}/resend |
| Events | GET /events, GET /events/{event_id} |
Account
Your key and your coins.
Check your API key: GET /me
Answers 200 with a Me.
Get your coin balance: GET /balance
1 coin = ₹1. Held coins are reserved for calls in progress.
Answers 200 with a Balance.
Employees
Your AI employees.
List employees: GET /employees
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
limit | query | integer | Default 25. 1 to 100. | |
starting_after | query | string or null |
Answers 200 with a Page_Employee_.
Get an employee: GET /employees/{employee_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
employee_id | path | id | yes |
Answers 200 with a Employee.
Phone numbers
Numbers your employees call from and answer.
List phone numbers: GET /phone-numbers
Answers 200 with a Page_PhoneNumber_.
Get a phone number: GET /phone-numbers/{number_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
number_id | path | id | yes |
Answers 200 with a PhoneNumber.
Calls
Ask an employee to call one person.
List calls: GET /calls
Single calls: API calls and lead-source leads, newest first. status is applied after reading, so a page may hold fewer than limit items while has_more is true.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
employee_id | query | id or null | ||
phone | query | string or null | ||
external_id | query | string or null | ||
source | query | api, lead_source, facebook, dashboard, callback, missed_call or null | ||
status | query | queued, scheduled, in_progress, completed, not_connected, failed, canceled, blocked or null | ||
created_after | query | time (UTC) or null | ||
created_before | query | time (UTC) or null | ||
limit | query | integer | Default 25. 1 to 100. | |
starting_after | query | string or null |
Answers 200 with a CallList.
Place a call: POST /calls
Ask an employee to call one person now (or at the next calling window).
Request body (CallCreate):
| Field | Type | Required | Notes |
|---|---|---|---|
employee_id | id | yes | |
phone | string or null | ||
name | string or null | ||
email | string or null | ||
details | object | ||
external_id | string or null | ||
metadata | object or null | ||
max_attempts | integer | Default 1. 1 to 3. | |
retry_after_minutes | integer | Default 60. 15 to 1440. | |
scheduled_at | time (UTC) or null | ||
contact_id | id or null | ||
lead_id | id or null | ||
dry_run | boolean | Default false. |
Answers 201 with a Call or CallPreview.
Get a call: GET /calls/{call_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
call_id | path | id | yes |
Answers 200 with a Call.
Cancel a call: POST /calls/{call_id}/cancel
Only a call still waiting (calling hours or a retry) can be cancelled.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
call_id | path | id | yes |
Answers 200 with a Call.
Leads
The result of every conversation.
List leads: GET /leads
Newest first. Poll with updated_after to pick up results as calls finish.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
employee_id | query | id or null | ||
campaign_id | query | id or null | ||
outcome | query | qualified, callback, converted, unqualified or null | ||
channel | query | instant, bulk, inbound or null | instant: single calls; bulk: campaigns; inbound: calls in. | |
hot | query | boolean or null | ||
sentiment | query | positive, neutral, negative or null | ||
external_id | query | string or null | ||
updated_after | query | time (UTC) or null | ||
created_after | query | time (UTC) or null | ||
created_before | query | time (UTC) or null | ||
limit | query | integer | Default 25. 1 to 100. | |
starting_after | query | string or null |
Answers 200 with a LeadList.
Get a lead, with its transcript: GET /leads/{lead_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
lead_id | path | id | yes |
Answers 200 with a Lead.
Campaigns
Call a list within calling hours.
List campaigns: GET /campaigns
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
employee_id | query | id or null | ||
status | query | string or null | ||
limit | query | integer | Default 25. 1 to 100. | |
starting_after | query | string or null |
Answers 200 with a CampaignList.
Create a campaign: POST /campaigns
Create a campaign with its people, optionally starting it (launch: true).
Request body (CampaignCreate):
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | yes | |
employee_id | id | yes | |
contacts | array of CampaignContactIn or null | Up to 1,000 people. | |
contact_list_id | id or null | Or a contact list you already have. | |
consent_source | string or null | Where these people agreed to be called (needed for promotional). | |
purpose | service, promotional | Default "service". | |
start_at | time (UTC) or null | Default: now. | |
end_at | time (UTC) or null | Default: 7 days after start. | |
calling_window_start | string | Default "10:00:00". | |
calling_window_end | string | Default "19:00:00". | |
lines | integer | Calls at the same time. Default 1. 1 to 100. | |
max_attempts | integer | Default 2. 1 to 3. | |
retry_after_minutes | integer | Default 120. 15 to 1440. | |
brief | string or null | ||
launch | boolean | Start calling (or schedule for start_at) right away. Default false. | |
dry_run | boolean | Default false. |
Answers 201 with a Campaign.
Get a campaign: GET /campaigns/{campaign_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
campaign_id | path | id | yes |
Answers 200 with a Campaign.
List a campaign's people: GET /campaigns/{campaign_id}/contacts
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
campaign_id | path | id | yes | |
status | query | pending, queued, answered, no_answer, busy, failed, skipped or null | ||
limit | query | integer | Default 25. 1 to 100. | |
starting_after | query | string or null |
Answers 200 with a CampaignContactList.
Start calling: POST /campaigns/{campaign_id}/launch
Starts now, or at start_at when that is later.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
campaign_id | path | id | yes |
Answers 200 with a Campaign.
Pause: POST /campaigns/{campaign_id}/pause
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
campaign_id | path | id | yes |
Answers 200 with a Campaign.
Resume: POST /campaigns/{campaign_id}/resume
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
campaign_id | path | id | yes |
Answers 200 with a Campaign.
Stop for good: POST /campaigns/{campaign_id}/stop
People not called yet are skipped. Calls already ringing finish.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
campaign_id | path | id | yes |
Answers 200 with a Campaign.
Contacts
People and your own details about them.
List contacts: GET /contacts
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
phone | query | string or null | ||
search | query | string or null | ||
limit | query | integer | Default 25. 1 to 100. | |
starting_after | query | string or null |
Answers 200 with a ContactList.
Create Contact: POST /contacts
Add a person. Their fields fill {{placeholders}} on campaign calls.
Request body (ContactIn):
| Field | Type | Required | Notes |
|---|---|---|---|
name | string or null | ||
phone | string | yes | |
email | string or null | ||
notes | string or null | ||
tags | array of string | ||
fields | object | Your contact fields: label → value. | |
consent_source | string or null | Where they agreed to be called. | |
dry_run | boolean | Default false. |
Answers 201 with a Contact.
Get Contact: GET /contacts/{contact_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
contact_id | path | id | yes |
Answers 200 with a Contact.
Update Contact: PATCH /contacts/{contact_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
contact_id | path | id | yes |
Request body (ContactPatch):
| Field | Type | Required | Notes |
|---|---|---|---|
name | string or null | ||
phone | string or null | ||
email | string or null | ||
notes | string or null | ||
tags | array of string or null | ||
fields | object or null | Replaces all fields. | |
consent_source | string or null |
Answers 200 with a Contact.
Delete Contact: DELETE /contacts/{contact_id}
Removes the person from your contacts; their past calls and leads stay.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
contact_id | path | id | yes |
Answers 204 No Content.
List your contact fields: GET /contact-fields
Answers 200 with a ContactFieldList.
Appointments
Booked on calls or by your team.
List appointments: GET /appointments
Booked on calls or by your team, by start time (default: 30 days back, 90 ahead).
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
starts_after | query | time (UTC) or null | ||
starts_before | query | time (UTC) or null |
Answers 200 with a AppointmentList.
Get Appointment: GET /appointments/{appointment_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
appointment_id | path | id | yes |
Answers 200 with a Appointment.
Do-not-call
Numbers never to call.
List do-not-call: GET /dnc
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
limit | query | integer | Default 25. 1 to 100. | |
starting_after | query | string or null |
Answers 200 with a DncList.
Add Dnc: POST /dnc
Never call this number again. Calls already waiting for it are stopped too.
Request body (DncAdd):
| Field | Type | Required | Notes |
|---|---|---|---|
phone | string | yes | |
reason | string or null | ||
dry_run | boolean | Default false. |
Answers 201 with a DncEntry.
Remove Dnc: DELETE /dnc/{phone}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
phone | path | string | yes |
Answers 204 No Content.
Webhooks
Results pushed to your URL as they happen.
List webhook endpoints: GET /webhook-endpoints
Answers 200 with a EndpointList.
Create a webhook endpoint: POST /webhook-endpoints
Events are POSTed to the URL, signed with the secret returned here (once).
Request body (EndpointIn):
| Field | Type | Required | Notes |
|---|---|---|---|
url | string | yes | A public https URL. |
events | array of call.completed, call.not_connected, call.inbound_missed, lead.updated, appointment.booked, appointment.updated | * | yes | |
dry_run | boolean | Default false. |
Answers 201 with a EndpointWithSecret.
Get Endpoint: GET /webhook-endpoints/{endpoint_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
endpoint_id | path | id | yes |
Answers 200 with a Endpoint.
Update Endpoint: PATCH /webhook-endpoints/{endpoint_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
endpoint_id | path | id | yes |
Request body (EndpointPatch):
| Field | Type | Required | Notes |
|---|---|---|---|
active | boolean or null | ||
events | array of call.completed, call.not_connected, call.inbound_missed, lead.updated, appointment.booked, appointment.updated | * or null |
Answers 200 with a Endpoint.
Delete Endpoint: DELETE /webhook-endpoints/{endpoint_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
endpoint_id | path | id | yes |
Answers 204 No Content.
Get a new signing secret: POST /webhook-endpoints/{endpoint_id}/rotate-secret
The old secret stops working at once; update your receiver first if you can.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
endpoint_id | path | id | yes |
Answers 200 with a EndpointWithSecret.
Send a test event: POST /webhook-endpoints/{endpoint_id}/test
Sends a test event ("test": true) within a few seconds.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
endpoint_id | path | id | yes |
Answers 200 with a Sent.
List deliveries to an endpoint: GET /webhook-endpoints/{endpoint_id}/deliveries
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
endpoint_id | path | id | yes | |
status | query | pending, sent, failed or null | ||
limit | query | integer | Default 25. 1 to 100. | |
starting_after | query | string or null |
Answers 200 with a DeliveryList.
Send a delivery again: POST /webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}/resend
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
endpoint_id | path | id | yes | |
delivery_id | path | id | yes |
Answers 200 with a Sent.
Events
Everything that happened, for 30 days.
List events: GET /events
Everything sent (or that would be sent) to webhooks in the last 30 days.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
type | query | call.completed, call.not_connected, call.inbound_missed, lead.updated, appointment.booked, appointment.updated or null | ||
created_after | query | time (UTC) or null | ||
limit | query | integer | Default 25. 1 to 100. | |
starting_after | query | string or null |
Answers 200 with a EventList.
Get an event: GET /events/{event_id}
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
event_id | path | id | yes |
Answers 200 with a Event.
Objects
Call
| Field | Type | Always | Notes |
|---|---|---|---|
id | id | yes | |
employee_id | id or null | yes | |
phone | string or null | yes | |
name | string or null | yes | |
details | object | yes | |
external_id | string or null | yes | |
metadata | object or null | yes | |
source | api, lead_source, facebook, dashboard, callback, missed_call | yes | |
status | queued, scheduled, in_progress, completed, not_connected, failed, canceled, blocked | yes | |
status_detail | string or null | yes | |
attempts_made | integer | yes | |
max_attempts | integer | yes | |
next_attempt_at | string or null | yes | |
last_call_id | id or null | yes | |
lead_id | id | yes | |
result | CallResult or null | yes | |
created_at | string or null | yes |
CallResult
| Field | Type | Always | Notes |
|---|---|---|---|
connected | boolean | yes | |
outcome | string or null | yes | |
summary | string or null | yes | |
captured | object | yes | |
hot | boolean | yes | |
sentiment | positive, neutral, negative or null | How the customer felt by the end of the call. | |
callback_at | string or null | yes | |
duration_seconds | integer or null | yes | |
coins_charged | number or null | yes | |
started_at | string or null | yes | |
ended_at | string or null | yes | |
recording_url | string or null | yes |
CallPreview
| Field | Type | Always | Notes |
|---|---|---|---|
dry_run | true | Default true. | |
would_call | boolean | yes | |
status | queued, scheduled, blocked, failed | yes | |
next_attempt_at | string or null | yes | |
checks | array of Check | yes | |
warnings | array of string | yes |
Lead
| Field | Type | Always | Notes |
|---|---|---|---|
id | id | yes | |
employee_id | id or null | yes | |
campaign_id | id or null | yes | |
channel | string or null | yes | |
direction | inbound, outbound or null | yes | |
name | string or null | yes | |
phone | string or null | yes | |
email | string or null | yes | |
status | string or null | yes | |
outcome | qualified, callback, converted, unqualified or null | yes | |
hot | boolean | yes | |
sentiment | positive, neutral, negative or null | How the person felt on their latest call. | |
callback_at | string or null | yes | |
captured | object | yes | |
contact | LeadContact or null | yes | |
external_id | string or null | yes | |
metadata | object or null | yes | |
call_id | id or null | yes | |
call_status | string or null | yes | |
business_number | string or null | yes | |
summary | string or null | yes | |
duration_seconds | integer or null | yes | |
coins_charged | number or null | yes | |
started_at | string or null | yes | |
ended_at | string or null | yes | |
recording_url | string or null | yes | |
transcript | array of TranscriptLine or null | ||
created_at | string or null | yes | |
updated_at | string or null | yes |
Campaign
| Field | Type | Always | Notes |
|---|---|---|---|
id | id | yes | |
name | string | yes | |
employee_id | id | yes | |
contact_list_id | id | yes | |
status | string | yes | |
purpose | string | yes | |
start_at | string or null | yes | |
end_at | string or null | yes | |
calling_window_start | string | yes | |
calling_window_end | string | yes | |
time_zone | string | yes | |
lines | integer | yes | |
max_attempts | integer | yes | |
retry_after_minutes | integer | yes | |
brief | string or null | yes | |
block_reason | string or null | yes | |
counts | CampaignCounts | yes | |
progress_pct | integer | yes | |
started_at | string or null | yes | |
completed_at | string or null | yes | |
created_at | string or null | yes |
CampaignCounts
| Field | Type | Always | Notes |
|---|---|---|---|
total | integer | yes | |
pending | integer | yes | |
in_progress | integer | yes | |
answered | integer | yes | |
no_answer | integer | yes | |
busy | integer | yes | |
failed | integer | yes | |
skipped | integer | yes | |
retrying | integer | yes | |
qualified | integer | yes | |
callbacks | integer | yes | |
won | integer | yes | |
not_interested | integer | yes | |
talk_seconds | integer | yes | |
coins_spent | number | yes |
Contact
| Field | Type | Always | Notes |
|---|---|---|---|
id | id | yes | |
name | string or null | yes | |
phone | string or null | yes | |
email | string or null | yes | |
notes | string or null | yes | |
tags | array of string | yes | |
fields | object | yes | |
consent_source | string or null | yes | |
consent_at | string or null | yes | |
created_at | string or null | yes |
Employee
| Field | Type | Always | Notes |
|---|---|---|---|
id | id | yes | |
name | string or null | yes | |
role | string or null | yes | |
status | string or null | yes | |
languages | array of string | yes | |
incoming_calls_enabled | boolean | yes | |
max_call_seconds | integer | Longest a call may run; the employee says goodbye 30 s before. Default 600. | |
script_strictness | integer | 1 talks freely .. 5 keeps exactly to the instructions' words. Default 3. | |
phone_number | string or null | yes | |
phone_number_id | id or null | yes | |
placeholders | array of string | yes | |
created_at | string or null | yes |
Endpoint
| Field | Type | Always | Notes |
|---|---|---|---|
id | id | yes | |
url | string | yes | |
events | array of string | yes | |
active | boolean | yes | |
last_status | integer or null | yes | |
last_error | string or null | yes | |
last_sent_at | string or null | yes | |
created_at | string or null | yes |
Event
| Field | Type | Always | Notes |
|---|---|---|---|
id | id | yes | |
type | string | yes | |
api_version | string | yes | |
created_at | string or null | yes | |
test | boolean | Default false. | |
data | object | yes |
Delivery
| Field | Type | Always | Notes |
|---|---|---|---|
id | id | yes | |
event_id | id or null | yes | |
event_type | string | yes | |
status | pending, sent, failed | yes | |
attempts | integer | yes | |
last_status_code | integer or null | yes | |
last_error | string or null | yes | |
next_attempt_at | string or null | yes | |
created_at | string or null | yes | |
delivered_at | string or null | yes |
Appointment
| Field | Type | Always | Notes |
|---|---|---|---|
id | id | yes | |
employee_id | id or null | yes | |
lead_id | id or null | yes | |
call_id | id or null | yes | |
customer_name | string or null | yes | |
customer_phone | string or null | yes | |
starts_at | string or null | yes | |
duration_minutes | integer | yes | |
status | string | yes | |
source | ai, manual | yes | |
notes | string or null | yes | |
created_at | string or null | yes |
Ready to try it? Sign in and open Developers to create a key, or ask us about your integration.