API reference
API reference
The CallShift REST API, resource by resource. Every request takes JSON, returns JSON and carries your API key.
| Base URL | https://api.callshift.ai |
| Authentication | Authorization: Bearer <API key> on every /v1 route. See Authentication. |
| Errors | An HTTP status and a JSON body. See Errors. |
| Pagination | page, limit and pageCount. See Pagination. |
| Machine-readable | OpenAPI 3.1 spec and Swagger UI, to generate a client or try a request. |
Resources
The pages of each resource are in English, the language of the OpenAPI spec.
Agents
Create, duplicate and configure voice agents, their call flow and their after-call analysis.
Tools
Functions an agent calls during the call: your endpoint, a web search, an SMS, an email.
Calls
Every call with its outcome, summary, transcript, recording and estimated cost.
Campaigns
Outbound runs: queue contacts, start and stop, retry.
Contacts
Update a contact of the CRM or opt a number out.
Phone numbers
The account's numbers and the agent answering each one.
SIP trunks
Carrier connections and their calls-per-second limit.
Webhooks
Endpoints that receive the after-call data.
Entities
Units of the account that group agents, numbers and webhooks.
Invoices
The account's invoices and payment history.
Health check
The one public route: it says whether the API and its database are up, without an API key.
curl "https://api.callshift.ai/health"const res = await fetch("https://api.callshift.ai/health");
const data = await res.json();import requests
res = requests.get(
"https://api.callshift.ai/health",
)
print(res.json()){
"status": "healthy",
"database": "connected"
}{
"status": "healthy",
"database": "connected"
}