Public API write surface
Public API v1 is read-only at launch. Current operations:GET /api/public/v1/customersGET /api/public/v1/appointments
/api/* routes are not part of the public contract.
Design Before Any Writes
No public write endpoint should ship until the operation has:- explicit API key scopes, separate from dashboard roles;
- Professional+ or Enterprise plan gating;
- org-scoped Prisma writes with
orgId; - idempotency keys for create/update operations;
- audit logging for sensitive changes;
- rate limits at least as strict as public v1 reads;
- OpenAPI documentation and examples;
- payload rules that keep PHI and clinical free text out of email/SMS/Stripe metadata.
Candidate Writes
Potential future writes, pending product decision:
Until this page changes, integrations should use the read-only endpoints and org webhooks.