Skip to content

API Reference

The iCallAgent public API lets a third-party app act on a user's workspace: list campaigns and agents, create campaigns, queue contacts for outbound calling, and subscribe to call-completion webhooks. It's the same API the Make.com integration is built on.

Base URL: https://api.icallagent.com/api/public/v1/

Auth: a personal API key (simplest, for your own workspace) or OAuth2 (for a third-party app acting on another user's workspace). See Authentication.

Quick example

bash
curl https://api.icallagent.com/api/public/v1/agents/ \
  -H "Authorization: Bearer ic_live_<your key>"
json
{ "results": [ { "id": 7, "name": "Support Agent" } ] }

Endpoints

MethodPathDescription
GET/campaigns/List campaigns in the caller's workspace
POST/campaigns/Create a campaign
GET/agents/List Live agents
GET/phone-numbers/List active provisioned numbers
POST/contacts/Upsert a contact and queue a call
POST/webhooks/subscribeSubscribe to call.completed events
DELETE/webhooks/{id}/Unsubscribe

Scope

The public API is intentionally narrow. It covers the operations needed to drive outbound calling from an external trigger (a form submission, a CRM update, a Slack message), not full account management. Agent creation, knowledge base management, and workspace settings are dashboard-only today — that includes creating and revoking personal API keys themselves (Settings → API Keys): there's no endpoint to mint a key from a key, by design.

Conventions

  • All request/response bodies are JSON, except file uploads.
  • List endpoints share the same pagination (limit/offset).
  • Errors follow one consistent shape regardless of endpoint.
  • A credential acts on exactly one workspace: whichever workspace a personal API key was created under, or whichever workspace was picked at OAuth consent time.

Built with VitePress.