API Reference

Endpoints are grouped by resource. Every endpoint requires a Bearer JWT and is scoped to the token's project_id.

Resources

Resource	Description	Reference
Authentication & Onboarding	Login, registration, project selection, onboarding.	View
Leads	Create, import, and manage CRM leads; opportunities & pipelines.	View
Activities (Timeline)	Unified call/note/email/custom activity timeline.	View
Custom Fields & Metadata	Custom fields, activity types, tags, statuses, outcomes.	View
Smart Views	Saved, filtered lead segments.	View
Power Dialer	Automated and manual outbound dialing.	View
Calls & Telephony	Live calls, phone numbers, Twilio provisioning, terminal.	View
Agents & Assistant	AI agents, templates, prompts, appointment tooling.	View
Tasks	Follow-up tasks / to-dos.	View
Jobs	Schedule background work such as calls.	View
Email & SMS	Domains, signatures, templates, files, SMS.	View
Dashboards & Reports	Dashboards, widgets, and reporting.	View
Workflows	Automation workflows, runs, triggers, secrets.	View
Team & Invitations	Team members and project invitations.	View
Billing	Stripe subscriptions, checkout, minute balance.	View
Integrations	Close.io, Calendly, sync & import.	View
API Keys	Programmatic API keys.	View
Email Tracking	Public open/click tracking endpoints.	View

About this reference

Every route mounted in the backend (backend-ki-caller/src/main.rs) is listed on the resource pages above, grouped by resource with its method and path. Pages like Add Leads and Create Job add full request/response detail against the standard page template; the remaining endpoints are being expanded to that depth over time. Auto-generated schemas for a subset of routes are also available via the Swagger UI (partial coverage).

Page template

Each endpoint page follows the same shape so the reference stays consistent:

1. Endpoint — method + path.
2. Authentication — always Bearer JWT unless noted.
3. Request body — JSON schema with an example.
4. Behavior — validation rules and side effects.
5. Success response — example envelope.
6. Error responses — the failure envelopes specific to the endpoint.