API Reference

This API reference is organized by domain instead of a single monolithic page.

Tenants API
Billing API
Usage API
Admin API
User API

Endpoint format (template)

Use this format for every endpoint entry:

### `METHOD /api/path/{param}`

- Purpose: What the endpoint does.
- Auth: Who can call it (for example Clerk session, ingest key, webhook signature).
- Request shape: Query/body parameters (Zod/TS as source of truth, concise summary).
- Response shape: Success response and key fields.
- Key errors: Important status codes and when they happen.
- Example: Short request/response example when useful.

Notes:

Write dynamic segments as {slug}, {id}, {userId}.
Do not include query string in the endpoint signature; document it under Request shape.
If an endpoint has no body, explicitly write none.