API Reference

Integrate with Ampairs services

Build on top of the same APIs that power our Angular web and Kotlin multiplatform apps. REST responses follow consistent envelopes with tenant-aware context.

Stable contracts

Authentication

Authenticate using OAuth 2.0 compatible flows with workspace headers. Requests include the `X-Workspace-Id` header to scope tenant data.

POST /auth/v1/init
{
  "phone": "+91XXXXXXXXXX"
}

Authentication & workspaces

Manage OTP flows, JWT sessions, workspace memberships, and RBAC assignments.

/auth/v1/workspace/v1

Commerce operations

Create and manage customers, products, orders, and invoices with GST-ready payloads.

/customer/v1/product/v1/order/v1/invoice/v1

Automation & engagement

Stream events, trigger notifications, and configure dynamic forms per workspace.

/event/v1/notification/v1/form/v1

Changelog

v1.4 · Added webhook retries with exponential backoff for notification deliveries.
v1.3 · Introduced order tagging and invoice reconciliation status endpoints.
v1.2 · Enhanced workspace membership APIs with device session metadata.

Get support

Request sandbox access, client credentials, or feature previews by contacting developers@ampairs.in.

Back to documentation