API Reference

Interactive explorer

Open the live explorer here:

/api-reference

Raw OpenAPI spec

Download or inspect the raw spec here:

/openapi/openapi.yaml
Shared API rules and conventions: /api/conventions
Error handling guidance: /api/error-handling

Maintenance rule

When the backend contract changes:

update the OpenAPI spec
update any guide pages affected by the change
keep endpoint examples aligned with the spec

Current status

The OpenAPI file in this repo is the start of the new docs system.

It should gradually replace the large contract Markdown file as the canonical API reference.

The OpenAPI spec now documents /api/v1/* as the canonical route surface. Legacy /api/* aliases are still supported by the backend during migration.

The highest-traffic schemas now include concrete examples so the reference is usable without reading controller code first.

The current spec already includes the full ticket API surface:

ticket CRUD
ticket activity
ticket comments
ticket notes
ticket attachments
duplicate detection and ticket AI endpoints

It also now includes the main onboarding and building-management surface:

invitations
invite acceptance
bulk invites
buildings
building assignments
residential units

And the current spec also covers:

organizations and organization user rosters
analytics
knowledge base
subscription plans, subscriptions, and effective limits
announcements
user profile, user preferences, and tenant residential-unit lookup
dashboard summary
global search