API Reference
Complete interactive API reference for all Aurion endpoints.
API Reference
Browse the full list of Aurion API endpoints below. Each endpoint includes request parameters, response schemas, and an interactive playground where you can test requests directly.
How to Use
- Expand an endpoint to see the full request/response schema
- Try it out using the interactive playground (requires an API key)
- Copy examples in cURL, Python, or TypeScript
API Versions
Aurion exposes two API versions:
| Version | Prefix | Description |
|---|---|---|
| v1 | /api/v1 | The public API surface — tickets, calls, usage, webhooks, and more. CSAT and end-user auth also live under /api/v1 but are not reachable with an API key (CSAT is not allowlisted; end-user auth uses an end-user JWT). |
| v2 | /api/v2 | Newer feature APIs — conversations, teams, SLA, workflows, analytics, contacts. These power the dashboard but are not yet reachable with a public API key (every /api/v2/* request returns 403; the only dedicated public v2 endpoint is GET /api/v2/health). |
New features are added to v2. The reachability of each category through a public API key is shown in the Endpoint Categories table below.
Authentication
Most public endpoints require an API key, sent in the X-API-Key header (preferred) or as Authorization: Bearer itsm_sk_… (see the per-category reachability in the table below). The End-User API uses a separate end-user JWT (Authorization: Bearer …), not an API key, and Help Center read endpoints are public and need no authentication at all. See Authentication for details on creating and managing API keys.
API keys use the format itsm_sk_{env}_{random} — itsm_sk_test_… for a sandbox tenant and itsm_sk_live_… for every other tenant, on production and staging alike.
curl "https://apps.aurionai.net/api/v1/tickets" \
-H "X-API-Key: itsm_sk_live_xxxx"Base URLs
| Environment | Base URL |
|---|---|
| Production | https://apps.aurionai.net |
| Staging | https://apps-staging.aurionai.net |
Endpoint Categories
The API key? column shows whether a category is reachable today with a public X-API-Key. An API key is gated to a fixed allowlist of /api/v1 prefixes; every /api/v2/* path returns 403, as do several non-allowlisted v1 paths. See Authentication for the full scope model.
Reachable with an API key
These v1 categories are in the public API-key allowlist and enforce a derived {resource}:{read|write} scope.
| Category | Version | Prefix | Scope | Guide |
|---|---|---|---|---|
| Tickets | v1 | /api/v1/tickets | tickets:read|write | Tickets |
| Calls & Recordings | v1 | /api/v1/calls | calls:read | Calls |
| Voice Widget | v1 | /api/v1/voice-widget | config:read|write | Voice Widget |
| Conversations | v1 | /api/v1/conversations | conversations:read|write | Conversations |
| Usage | v1 | /api/v1/usage/summary, /api/v1/usage/details | usage:read | Usage & Billing |
| Billing | v1 | /api/v1/billing | billing:read|write | Usage & Billing |
| Requesters & Tenant Users | v1 | /api/v1/requesters, /api/v1/tenant/users | users:read|write | Authentication |
| Exports | v1 | /api/v1/tenant/exports | exports:read|write | Usage & Billing |
| Configuration | v1 | /api/v1/configuration, /api/v1/integrations, /api/v1/telephony, /api/v1/onboarding, /api/v1/tenant | config:read|write | Authentication |
| Webhooks | v1 | /api/v1/webhooks | webhooks:read|write | Webhooks |
Not reachable with an API key
These categories exist in the product but return 403 for API-key requests today. The /api/v2/* paths fall through the allowlist (the only dedicated public v2 endpoint is GET /api/v2/health); the non-allowlisted v1 paths are denied for the same reason. They are reachable through an authenticated dashboard session, the End-User JWT, or — for Help Center — public reads.
| Category | Version | Prefix | API key? | Guide |
|---|---|---|---|---|
| Conversations (v2) | v2 | /api/v2/conversations | No — 403 (dashboard session) | Conversations |
| Knowledge Base | v2, unversioned | /api/v2/kb, /api/kb | No — 403 (dashboard session) | Knowledge Base |
| Custom Fields | v2 | /api/v2/custom-fields | No — 403 (dashboard session) | Custom Fields |
| Channels (Email) | v2 | /api/v2/email | No — 403 (dashboard session) | Channels |
| Channels (WhatsApp) | v2 | /api/v2/whatsapp | No — 403 (dashboard session) | Channels |
| Saved Replies | v2 | /api/v2/saved-replies | No — 403 (dashboard session) | Channels |
| Automation Rules | v2 | /api/v2/automation-rules | No — 403 (dashboard session) | Automation |
| AI Automation | v2 | /api/v2/ai-automation | No — 403 (dashboard session) | Automation |
| Workflows | v2 | /api/v2/workflows | No — 403 (dashboard session) | Automation |
| SLA Policies | v2 | /api/v2/sla | No — 403 (dashboard session) | SLA |
| Teams | v2 | /api/v2/teams | No — 403 (dashboard session) | Teams |
| On-Call | v2 | /api/v2/oncall | No — 403 (dashboard session) | On-Call |
| Notifications | v2 | /api/v2/notifications | No — 403 (dashboard session) | Notifications |
| Contacts | v2 | /api/v2/contacts | No — 403 (dashboard session) | Contacts |
| Companies | v2 | /api/v2/companies | No — 403 (dashboard session) | Contacts |
| Analytics (v2) | v2 | /api/v2/analytics | No — 403 (dashboard session) | Analytics |
| Analytics (v1) | v1 | /api/v1/analytics | No — 403 (not allowlisted) | Analytics |
| CSAT Surveys | v1 | /api/v1/csat | No — 403 (not allowlisted) | CSAT |
| Help Center | v1 | /api/v1/help-center | No API key needed — public reads | Help Center |
| End-User Auth | v1 | /api/v1/app/auth | No — end-user JWT, not an API key | End-User API |
| End-User Tickets | v1 | /api/v1/app/tickets | No — end-user JWT, not an API key | End-User API |
| API Keys | v1 | /api/v1/api-keys | No — managed via dashboard session (JWT) | Authentication |
Rate Limits
Rate limits depend on your tenant's plan and on the kind of endpoint, with a per-minute and a
10-second burst limit, the same in production and staging. See Error Handling → Rate Limiting for the limits per plan,
the headers and the 429 bodies.
Related
- Getting Started — Create your first API key
- Authentication — API key scopes and management
- Error Handling — Status codes and retry strategies
- Pagination — Paginating list responses