API v1

API Scope

API v1 is private-first for Domfolio web and future mobile clients. It provides auth/session, identity/workspace membership, core operations, integration visibility, and schema docs.

Core Conventions

• Namespace: /api/v1/.
• Timestamp format: ISO-8601.
• Envelope shape: {"ok": true|false, ...} with consistent meta and timestamp.
• Correlation ID: response header X-Request-ID.
• Idempotency: mutation endpoints accept Idempotency-Key.
• Pagination: page, page_size (bounded).
• Sorting: ordering with resource-level allow lists.

Reference Files

• docs/api/README.md (index)
• docs/api/conventions.md
• docs/api/auth.md
• docs/api/idempotency.md
• docs/api/errors.md
• docs/api/pagination-filtering-sorting.md
• docs/api/versioning.md

Auth and Identity Endpoints

• POST /api/v1/auth/token/
• POST /api/v1/auth/token/refresh/
• POST /api/v1/auth/token/revoke/
• GET /api/v1/auth/session/
• GET /api/v1/me/
• GET|POST /api/v1/workspaces/
• GET /api/v1/memberships/, /roles/, /permissions/

Domain and Integration Endpoints

• Domain collections/details: properties, units, leases, tenants, maintenance requests, work orders, payments, documents.
• Integrations: connections, sync jobs, sync errors, webhook receipts, inbound webhook endpoints.
• Schema/docs: GET /api/v1/schema/ and GET /api/v1/docs/.

Full reference lives in docs/api/ and route definitions in backend/apps/core/api/urls.py.