Integration overview
HTTP API at /api with session or Business Application credentials.
Last updated 2026-09-01
What it is
Application exposes a JSON HTTP API under /api. Browser clients use the session cookie; server-side integrations use Business Application headers. Successful list responses commonly return { success, total, limit, offset, data }. Failures use { success: false, message } (and optional field errors).
Who can access
Integrators with a Business Application, or browser sessions for the same Business. Platform admin APIs under /api/platform are separate and out of scope for tenant integrations.
How to start
- Create credentials in Business Applications
- Read Authentication
- Explore OpenAPI / Swagger when enabled
- Copy a recipe for your first call
Base URL
Point clients at your API host plus /api (for example the same origin your frontend configures as VITE_API_BASE_URL).
Constraints
- No OAuth for Integration Applications — client id/secret headers only
- No general tenant webhook catalog; Stripe webhook is for platform billing only
- Scopes exclude roles, business settings, dashboards, and applications CRUD
- Rate limits apply per route