Axis Unified Inbox API
The REST API behind Axis — a unified inbox that merges WhatsApp (API & QR), Facebook and Instagram, layered with AI chat widgets, agent tooling and cross-channel analytics. This reference is generated directly from the API's routes, FormRequest validation rules and API Resources, so it stays in lock-step with the code.
Base URLs
http://localhost:8000https://api.axis.imConfigured in .env.local (AXIS_API_URL_*) — see .env.example.
All endpoints are prefixed with /api. Requests and responses are JSON; always send Accept: application/json so validation errors return as JSON rather than a redirect.
# 1. Obtain a JWT
curl -X POST 'https://api.axis.im/api/user/login' \
-H 'Accept: application/json' -H 'Content-Type: application/json' \
-d '{"email":"[email protected]","password":"secret-password"}'
# 2. Use the returned token
curl 'https://api.axis.im/api/conversations' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {token}'Authentication at a glance
Most endpoints use a JWT bearer token issued for the user guard. See Authentication for token issuance, API keys and webhook verification.
HTTP verbs
Use it in Postman
Download a ready-to-import Postman Collection v2.1 covering all 599 endpoints, foldered by resource group, with example bodies built from the same validation rules shown here.
- Import the file into Postman (File → Import).
- Run
POST /user/loginwith your credentials — a test script saves the JWT into the{{access_token}}collection variable automatically. - Every other request inherits that bearer token. Just hit Send.
Each resource group also has its own smaller collection — see the button on any reference page. Requests point at {{baseUrl}}, preset to https://api.axis.im.
Resource groups
Voice & Flow Builder
125Voice/flow builder nodes, transitions and runtime.
Campaigns
62Broadcast campaigns, links, media and scheduling.
AI & Agents
47AI agents, GPTs, knowledge/data sources, crawling and suggestions.
WhatsApp Sessions
33WhatsApp QR / session (Wasender) management.
Conversations
24Unified-inbox conversation threads, replies, takeover and summaries.
Contacts & Segments
24CRM contacts, imports/exports and audience segments.
Users & Profile
22The authenticated user, profile, device tokens and account management.
Channels
22WhatsApp, Facebook, Instagram and web-widget channel connections.
Evolution (WA)
22Evolution API WhatsApp instances and webhooks.
Reports
21Operational reports and exports.
Inbox
20Inbox listing, filters, priority inbox and assignment.
Tickets
20Support tickets raised from conversations.
Payments
19Payment initiation, callbacks and status (incl. M-Pesa).
Authentication
15Login, token issuance, refresh, social auth, password reset and session status.
Miscellaneous
11Utility and integration endpoints defined as route closures.
Messages
9Individual messages inside a conversation.
SMS
8SMS sending, delivery and allowances.
Notifications
8In-app and push notifications.
Teams
8Agent teams and membership.
Canned Responses
7Saved / canned reply snippets.
Interactive Replies
7Interactive/quick-reply message templates.
Labels
7Conversation and contact labels.
Leads
7Inbound leads capture.
Reviews
7Customer reviews and ratings.
Engage Admin
6Engage administrative API (Engage API key).
Channel Setup
6Onboarding and provisioning flows for channels.
Orders
6Commerce orders.
Roles & Permissions
5Spatie roles and permission assignment.
Google Business
4Google Business Profile connection, locations and review sync.
Dashboard
2Dashboard aggregate metrics.
Auto Responses
2Automated response rules.
Billing
2Subscriptions, seats and plan billing.
API Keys
1API key issuance and management.
History
1Activity history.
Media
1Image and media handling.
Email delivery-report / tracking webhooks.
Notes
1Internal notes on conversations/contacts.
Packages / Plans
1Subscription packages and plan limits.
Analytics
1Channel, agent and conversation analytics.
Settings
1Workspace settings.
Setup
1Workspace/account setup.
Finance
1Financial records.
Meta
1Meta (Facebook/Instagram) integration endpoints.