OpenAPI & Swagger
Explore the live API schema when Swagger is enabled.
Last updated 2026-09-01
What it is
The API server can serve Swagger UI for the OpenAPI description of Application routes. When enabled, open /swagger/index.html on the API host (not under /api).
Who can access
Availability depends on the API deployment flag SWAGGER=true. Production may disable Swagger; local or staging environments often enable it for integrators.
How to
- Confirm SWAGGER=true on the API server
- Open https://<api-host>/swagger/index.html
- Authorize with session cookie flows or test Application headers as supported by the UI
- Cross-check request bodies against schemas and these docs
Tip
Prefer Swagger for field-level schemas; prefer these guides for product constraints (scopes, soft-delete, no webhook catalog).
Constraints
- If SWAGGER is not true, the UI will not be available — that is expected
- Swagger reflects the server build; treat it as environment-specific