Skip to main content
API reference

Kickcall Platform API1.0.0

Kickcall portal HTTP APIs (OpenAPI 3.0.3).

Sections (headings only)

Use x-tagGroups (Redoc / Stoplight):

  1. Business — paths /business/*
  2. Agency — paths /agency/*

Tags under each heading are resource names only (Locations, Onboarding, Webhooks, …) — not Business: … / Agency: ….

A few agency resources share a short name with business (e.g. customers vs business profile). In this combined file those agency tags use a distinct label (Customers, Subscription, Staff, …) so they do not mix folders. Standalone agency/business specs keep the simple names.

Auth

Key/agency/business
Agency API keyyesyes (+ Business-Id)
Business API keynoyes

Tenant = hostname. Envelope { data, links, meta } · errors { error }.

Base URL

All requests use one of these base URLs:

  • https://api-example.kickcall.ai/api/v1Production
  • http://api-kickcall.lvh.me:3000/api/v1Local development

Authentication

AuthorizationstringheaderBearer token

JWT from OTP login, or business/agency API key string.

X-Api-KeystringheaderAPI key

Business or agency API key.

auth_tokenstringcookieAPI key

Signed session cookie set after verify_code.

Business-IdstringheaderAPI key

Target business id (or external_reference_id). Required for most endpoints.

AuthorizationstringheaderBearer token

JWT from OTP login, or agency API key string.

X-Api-KeystringheaderAPI key

Agency API key.

auth_tokenstringcookieAPI key

Signed session cookie set after verify_code.

curl --request GET \
  --url https://api-example.kickcall.ai/api/v1/business/businesses \
  --header 'Authorization: Bearer <token>'

Still need help? Ask the team