REST API

All product APIs live under versioned prefixes such as /api/v1/control/*, /api/v1/core/*, and module namespaces like /api/v1/crm/*. Responses use a shared envelope with success, data, and meta fields; errors return stable code values safe to branch on in clients.

Pagination and sorting

List endpoints accept page, pageSize, sort, and order parameters. Paginated payloads echo totals in meta.pagination so UI widgets can render predictable footers.

OpenAPI

Each app publishes a machine-readable spec alongside human documentation here. Regenerate clients when semver bumps surface new fields rather than scraping HTML guides.

The two planes publish separate documents. Customers integrating with their own Avanora instance want the Core spec; the Control spec describes the operator plane and is not part of the customer-facing surface.

• Core API referenceServed by every tenant at /api/docs on its own host, with the OpenAPI 3.1 document at /api/docs/openapi.json. Covers /api/v1/core/* plus the installed business modules — point your client generator here.
• Control API referenceBrowse and try every /api/v1/control/* endpoint. Operator sign-in required — this is the Avanora administration plane, not a customer integration surface.
• Control OpenAPI 3.1 documentAlso behind the operator session. Download it while signed in to feed a generator or Postman.