--- title: "CallsAround API Reference" description: "Interactive reference for the CallsAround REST API: phone lines, escalation chains, calls with recordings and transcripts, usage, SMS and voice notifications, and signed webhooks." lang: en json-ld: --- [← CallsAround](https://callsaround.com/) [Pricing](https://callsaround.com/pricing) [Blog](https://callsaround.com/blog) [Get API access](https://callsaround.com/signup) Open Search Keyboard Shortcut: Control k - [ Introduction ](#description/introduction) Open Group - Introduction - [ Meta ](#tag/meta) Close Group - Meta - [ Liveness probe (no auth) HTTP Method:   GET ](#tag/meta/GET/ping) - [ This document (no auth) HTTP Method:   GET ](#tag/meta/GET/openapi.json) - [ Organizations ](#tag/organizations) Open Group - Organizations - [ Lines ](#tag/lines) Open Group - Lines - [ Numbers ](#tag/numbers) Open Group - Numbers - [ Escalation chains ](#tag/escalation-chains) Open Group - Escalation chains - [ Territories ](#tag/territories) Open Group - Territories - [ Calls ](#tag/calls) Open Group - Calls - [ Messages ](#tag/messages) Open Group - Messages - [ Usage ](#tag/usage) Open Group - Usage - [ Messaging ](#tag/messaging) Open Group - Messaging - [ Webhook subscriptions ](#tag/webhook-subscriptions) Open Group - Webhook subscriptions - [ Webhook events ](#tag/webhook-events) Open Group - Webhook events - [ Models ](#models) Open Group - Models [Open API Client](https://client.scalar.com/?url=https%3A%2F%2Fapi.callsaround.com%2Fapi%2Fv1%2Fopenapi.json&integration=vue&utm_source=api-reference&utm_medium=button&utm_campaign=sidebar) [Powered by Scalar](https://www.scalar.com) Open Menu v1.0.0 OpenAPI 3.1.0 # CallsAround API [CallsAround ](https://callsaround.com) Download OpenAPI Document json Download OpenAPI Document yaml REST API for lines, escalation chains, calls (with media), usage, SMS/voice notifications, and webhook subscriptions. Auth: `Authorization: Bearer ca_(test|live)_…`. Outbound webhooks: X-CallsAround-Signature: t=,v1= — verify with the reference client (5-min tolerance); retries: 5 attempts with 1/5/25/120-minute backoff, then dead-letter; events: call.completed, emergency.dispatched, line.health\_changed, call.uncovered, call.failed, usage.threshold, usage.exceeded, message.taken. Every response is a JSON envelope: `{ ok: true, data, request_id }` on success, `{ ok: false, error: { code, message, request_id } }` on failure. Rate limit: 120 requests/minute per key. Agency keys act on their own org and all descendant client orgs. ## Connecting a CRM or job platform (Zapier) No native connector is required for most tools: point a webhook subscription at a **Zapier _Catch Hook_** (Webhooks by Zapier) and map the fields into any app with Zapier write actions — e.g. **Albi** (Create Contact / Create Project / Create Project Note), or thousands of others. Recipe: 1. In Zapier, create a Zap with trigger **Webhooks by Zapier → Catch Hook**; copy the hook URL. 2. In the CallsAround dashboard (**Developers → Add webhook subscription**) or via `POST /webhooks`, subscribe that URL to `message.taken` (leads with content) and/or `call.completed` (every call; a taken message rides along in `data.message`). 3. Map `data.contact_name`, `data.callback_e164`, `data.address`, `data.problem`, and `data.urgency` into your app's action fields. Zapier's Catch Hook does not verify signatures; if you need verification, use Zapier's _Catch Raw Hook_ with a Code step, or any endpoint of your own (see the signature scheme under Webhook events below). Server Server: https://api.callsaround.com/api/v1 ## Authentication Selected Auth Type: bearerKey API key from the dashboard's Developers page. The full token is shown once at creation; keys carry scopes and an optional expiry. More Bearer Token : Show Password Client Libraries Shell Ruby Node.js PHP Python More Select from all clients Shell Curl ## Meta ​ Copy link Liveness and this document. No authentication. Meta Operations - get /ping - get /openapi.json ### Liveness probe (no auth) ​ Copy link Responses - 200 Success envelope `{ ok, data, request_id }` application/json - 4XX Error envelope `{ error: { code, message, request_id } }` — 401 bad key, 403 missing scope, 404, 409 idempotency conflict, 429 rate limit (120 req/min/key) application/json Request Example for get /ping Shell Curl ```curl curl https://api.callsaround.com/api/v1/ping ``` Copy Test Request (get /ping) Status: 200 Status: 4XX Show Schema ```json { "ok": true, "data": { "pong": true, "at": "2026-07-14T18:03:12.345Z" }, "request_id": "req_a1b2c3d4" } ``` JSON Copy Success envelope `{ ok, data, request_id }` Show sidebar Search - Meta Close Group - Liveness probe (no auth) HTTP Method:   GET - This document (no auth) HTTP Method:   GET - Organizations Open Group - Lines Open Group - Numbers Open Group - Escalation chains Open Group - Territories Open Group - Calls Open Group - Messages Open Group - Usage Open Group - Messaging Open Group - Webhook subscriptions Open Group - Webhook events Open Group GET Server: https://api.callsaround.com/api/v1 /ping Copy URL Send get request to https://api.callsaround.com/api/v1/ping GET Copy URL Send get request to https://api.callsaround.com/api/v1/ping [Open API Client](https://client.scalar.com/?url=https%3A%2F%2Fapi.callsaround.com%2Fapi%2Fv1%2Fopenapi.json&operation_path=%2Fping&operation_method=get&utm_source=api-reference&utm_medium=button&utm_campaign=modal) Close Client Liveness probe (no auth) AllAuthCookiesHeadersQuery All ## Authentication Selected Auth Type: bearerKey API key from the dashboard's Developers page. The full token is shown once at creation; keys carry scopes and an optional expiry. More Bearer Token : Show Password ## Variables Enabled Key Value ## Cookies Enabled Key Value ## Headers Enabled Key Value accept application/json ## Query Parameters Enabled Key Value ## Request Body No Body None ## Code Snippet (Collapsed) Shell Curl Response AllCookiesHeadersBody All [Powered By Scalar.com](https://www.scalar.com) Send Request Control Enter