API Reference

Build on Axially

REST API. Bearer + API key authentication. Per-route idempotency. RBAC enforced. OpenAPI 3.1.

Download OpenAPI specGet API key

Authentication

API key (recommended for server-to-server)
curl https://app.axially.com/api/v1/sales/deals \
  -H "x-api-key: sk_live_..."
OAuth 2.0 (user delegation)

PKCE flow for partner OAuth registration. Contact sales.

Idempotency

Every POST / PUT / PATCH accepts Idempotency-Key header. Replays inside 10-minute TTL return cached response.

curl -X POST https://app.axially.com/api/sales/deals \
  -H "x-api-key: sk_live_..." \
  -H "Idempotency-Key: 7f3a..." \
  -H "content-type: application/json" \
  -d '{"name":"Acme Renewal","value":240000}'

Rate Limits

PlanReads / minWrites / min
Free6030
Starter600120
Business6,0001,200
EnterpriseCustomCustom

Webhooks

HMAC-SHA256 signed

Every outbound webhook includes x-axially-signature = hex(hmac_sha256(secret, raw_body)). Verify before processing. Keys rotate w/ 7-day grace.

Endpoints

Work
/api/v1/work/projects
GET · POST · PATCH · DELETE
Sales
/api/v1/sales/deals
GET · POST · PATCH · DELETE
Finance
/api/v1/finance/invoices
GET · POST · PATCH · DELETE
People
/api/v1/people/employees
GET · POST · PATCH · DELETE
Talent
/api/v1/talent/candidates
GET · POST · PATCH · DELETE
Intelligence
/api/v1/intelligence/agents
GET · POST · PATCH · DELETE

Full reference: OpenAPI 3.1 spec (JSON) · User guides