API overview

Shipped surface

Area	Endpoints
Core	`GET /ping`, `GET /omni/templates`, `POST /leads`
Outbound	`GET /campaigns`, `GET /campaigns/{id}`, `GET /campaigns/{id}/contacts` (read-only; create/start in dashboard)
Contacts	`GET/DELETE /contacts/{id}`, `GET .../calls`, `GET .../calls/{callId}`, `POST .../cancel`, `POST .../followups`
Calls	`GET /calls`, `GET /calls/active`, `GET /calls/{id}`, `GET /calls/{id}/recording` - scopes `calls:read` / `recordings:read`
Credits	`GET /credits`, `GET /credits/transactions` - scope `credits:read`
Analytics	`GET /analytics/calls` - scope `analytics:read`
Webhooks	`GET/POST/PATCH/DELETE /webhooks` - scope `webhooks:write`
Events	`POST /events`, `GET/POST/DELETE /event-routes`
Inbound	`GET/POST /inbound-agents`, `GET/PATCH .../{id}`, `POST .../activate`, `POST .../sync-doctors`, `POST .../generate-script`, `POST .../crm/lookup` - create/PATCH accept `companyId` + `selectedKnowledgebases` (fileId list)
Numbers / credits	`GET /numbers`, `GET /numbers/available`, `POST /numbers/purchase` (pool; debit credits)
Companies	`GET/POST /companies`, `GET/PATCH/DELETE /companies/{id}` - scopes `companies:read` / `companies:write`
Knowledge bases	`GET/POST /knowledge-bases/documents`, `GET/DELETE .../{fileId}`, `GET .../upload-billing-info` - scopes `knowledge:read` / `knowledge:write`

Scoped access

Default API keys include lead/inbound/calls:read/credits:read/webhooks:write. Super Admin may also grant:

companies:* / knowledge:* - company profiles + KB metadata
analytics:read - call aggregates
recordings:read - short-TTL signed recording URLs

Missing scope → 403 with reasonCode: "forbidden" and a missing array. Company and KB responses never include SMTP passwords, WhatsApp tokens, or file download URLs. Call list/detail never return permanent recording storage URLs.

Explicitly not in public API

Capability	Where it lives
Create / update / delete / start campaigns	Dashboard wizard
Twilio / Telnyx number purchase	Dashboard
Credit top-up / concurrency packages	Dashboard
KB file download / binary stream	Dashboard session (not v1)
CRM OAuth (Zoho, HubSpot, …)	Dashboard Integrations
Custom API URL on inbound healthcare HMS	Public API create/update inbound agent (or inbound setup UI)
DNC list management	Dashboard

Custom CRM pattern

UI: empty API campaign → start
API: POST /leads (or POST /events with a mapped eventType)
WhatsApp/email: GET /omni/templates then pass ids + templateVariables / whatsappParams - guide
Optional: POST /api/v1/webhooks (or API Access → Notifications) for status / billing callbacks
Usage UI: poll GET /calls + GET /credits/transactions; see Healthcare HMS integration
Inbound: wire Sheets/Zoho/Custom API in UI → POST .../crm/lookup when you need a read without a live call.

Versioning

/api/v1 remains supported ≥ 12 months after any future /api/v2 GA; breaking changes get ≥ 90 days notice.

Basics

Set up and test

Send leads

Track contacts

Calls and recordings

Webhooks

Events

Credits and analytics

Inbound agents

Numbers and voices

Companies

Knowledge bases

Shipped surface

Scoped access

Explicitly not in public API

Custom CRM pattern

Versioning

​Shipped surface

​Scoped access

​Explicitly not in public API

​Custom CRM pattern

​Versioning

Shipped surface

Scoped access

Explicitly not in public API

Custom CRM pattern

Versioning