A consistent, fast REST API for the Braver care platform: patients, scheduling, clinical documentation, communications, and realtime events — with one predictable set of conventions across every resource.
Lists always return { count, data, page, pageSize }. Mutations return a
predictable action / status / id result instead of bare booleans.
The OpenAPI document is generated from the running API, so the reference always matches the deployed routes — including request and response schemas.
Open the reference →Subscribe to organization, patient, and actor channels over an authenticated websocket. Platform events are documented as OpenAPI webhooks.
Realtime docs →The same query parameters work on every list endpoint.
| Parameter | Behavior |
|---|---|
page, pageSize |
1-based pagination. Defaults to page 1 with 50 rows; pageSize max is 100. |
sort |
Comma-separated camelCase fields; prefix with - for descending, for
example sort=lastName,-createdAt.
|
createdAtFrom / createdAtTo |
Date and time ranges use From and To suffixes. |
userIds=a,b,c |
List filters use plural camelCase names with comma-separated values. |
search |
Broad resource search; Contains suffixes match a single field. |
includeArchived, archived |
Soft-deleted rows are excluded by default. |
Requests authenticate with a Cognito bearer JWT. Braver staff users can access staff routes; patient users can access only patient-scoped routes for their linked patient record.
# List patients (staff) curl https://api.bebraver.com/v1/patients?pageSize=25 \ -H "Authorization: Bearer $BRAVER_TOKEN" # Response { "count": 125, "data": [ ... ], "page": 1, "pageSize": 25 }