Getting Started

Overview

The REST API is the primary programmatic surface: JSON under https://app.axiomatic.software/api/..., documented in openapi.json and in the sidebar categories below.

• Authentication: Authorization: Bearer ak_... using an API key from API keys in Settings. Keys are scoped to one entity and to coarse module scopes (read:ledger, write:crm, …). Routes that use withTenant enforce the scope implied by the first path segment after /api/ (for example, /api/ledger/... needs ledger scopes). Write scope implies read for the same module.
• Interactive use: Logged-in browser traffic hits the same routes; you do not send a Bearer header manually from the UI.

Base URL: https://app.axiomatic.software

Authentication

curl "https://app.axiomatic.software/api/ledger/accounts?entityId=<uuid>" \
  -H "Authorization: Bearer ak_..."

Create and revoke keys under Settings → API keys. Rate limits apply per key.

Multi-tenant routing

Each organization has an isolated database. For routes that use withTenant, entity scope is resolved from (in order):

1. entityId or entity_id query parameter
2. x-entity-id header — common for browser shells and GET requests that do not put entityId in the query string
3. On POST/PUT/PATCH (non-GET), entityId in the JSON body if not already set above
4. Authorization: Bearer ak_... — the API key pins the entity; include entityId in query/body/header only when it must match that key’s entity
5. x-tenant-id — advanced control-plane resolution when applicable

CRM, Sales, Helpdesk, and most module APIs use this model so the same routes work for session cookies and Bearer API keys.

Endpoints

Browse the sidebar: each group (System, Core, Ledger, …) is a collapsible folder. Short links without the section segment (for example /docs/api/entities) redirect to the canonical URL (/docs/api/core/entities).

Rate limits

API requests are rate-limited per API key. Typical limits:

• 100 requests/minute for read endpoints (GET)
• 30 requests/minute for write endpoints (POST/PUT/PATCH/DELETE)

Rate limit headers may be included in responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 97
X-RateLimit-Reset: 1709164800

Errors

All errors return a JSON body with an error field:

{ "error": "Entity not found" }