← Back to Wardrowbe

Wardrowbe API

Wardrowbe's backend is a self-hosted FastAPI service, fully open source. Deploy your own instance and its OpenAPI spec, interactive docs, and every endpoint listed below are live on that instance right out of the box.

There is no hosted, publicly reachable API on wardrowbe.com itself. The cloud product at app.wardrowbe.com is a subscription service for end users, not a public developer API.

OpenAPI spec

A snapshot of the current API surface, generated from the self-hosted backend:

/openapi.json

Once you deploy your own instance, that instance serves the same spec live at /openapi.json, plus interactive docs at /docs and /redoc.

Authentication

Every route requires a Bearer JWT, issued via OIDC login (PocketID, Keycloak, or any OIDC provider) or dev-credentials mode for local development. Send it as Authorization: Bearer <token>.

Access beyond authentication is resource-scoped rather than OAuth-scoped: family accounts carry a member or admin role, and routes check that role on the specific family being accessed. There is no separate API-key or client-credentials flow.

Errors

Every error response is JSON, including 404s and validation failures. Validation errors return a 422 with a detail string and a per-field errors array naming what failed and why.

Self-hosting

Full setup instructions, environment variables, and feature docs live in the Getting Started guide. Source, issues, and pull requests are on GitHub.

View on GitHubBrowse the docs