API Documentation
A REST API over every Akontec product, with OAuth 2.0, webhooks and predictable JSON. Available on Premium plans and to all technology partners.
https://api.akontec.store/v1
Regional hosts available for EU and US tenants.
OAuth 2.0 client credentials, or a scoped API key in the Authorization: Bearer header.
600 requests/minute per tenant, 5,000/minute for enterprise. Limits returned in X-RateLimit-* headers.
Quick start
Create an API key from Dashboard → Settings → API, then call any endpoint. Every response is JSON; errors use standard HTTP status codes with a machine-readable code and a human message.
curl https://api.akontec.store/v1/leads \
-H "Authorization: Bearer ak_live_xxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"name": "Priya Sharma",
"email": "priya@example.com",
"phone": "+919000000000",
"source": "website",
"pipeline": "inbound-sales"
}'A successful create returns 201 with the stored object, including the generated id and created_at.
Core endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/customers | List customers with pagination and filters |
POST | /v1/customers | Create a customer record |
GET | /v1/leads | List leads; filter by stage, owner, source |
POST | /v1/leads | Push a lead from any external form or ad |
GET | /v1/invoices | List invoices with status and ageing |
POST | /v1/invoices | Raise an invoice and get a payment link |
GET | /v1/products | Catalogue items with stock across warehouses |
POST | /v1/tickets | Create a support ticket in Akon Helpdesk |
GET | /v1/employees | Employee master from Akon HRM |
POST | /v1/agents/{agent_id}/messages | Send a message to an AI agent conversation |
?limit= (max 200), ?cursor=, ?updated_since= and field filters. Responses include has_more and next_cursor.Webhooks
Register endpoint URLs under Settings → Webhooks. Each delivery is signed with an HMAC-SHA256 signature in X-Akontec-Signature; verify it against your webhook secret before acting on the payload. Failed deliveries retry with exponential backoff for 24 hours.
| Event | Fires when |
|---|---|
lead.created | A new lead entered any pipeline |
deal.stage_changed | A deal moved between stages |
invoice.paid | Payment received against an invoice |
order.placed | New order in Akon Commerce or POS |
ticket.created | New support ticket |
ticket.resolved | Ticket closed, with CSAT if collected |
stock.low | An item crossed its reorder point |
agent.handoff | An AI agent escalated to a human |
SDKs and tooling
- Node.js —
npm i @akontec/sdk - Python —
pip install akontec - PHP — Composer package
akontec/sdk - Postman collection — importable from the API settings page
- OpenAPI 3.1 spec —
https://api.akontec.store/v1/openapi.json
Versioning and support
The API is versioned in the path. Breaking changes ship as a new version with at least 12 months of overlap; additive changes may appear in v1 without notice, so parse defensively. Deprecations are announced in the release notes and by email to API key owners.
Building on Akontec?
Get sandbox credentials, the OpenAPI spec and a developer contact.