Find the resource
Browse routes by the part of care you’re supporting—not by an internal service name.
Open the reference →Braver API · private preview
Care is human. Your integration can be thoughtful.
Build on Braver’s care platform with predictable REST resources for patients, scheduling, clinical documentation, communications, and realtime events.
One contract
Consistent list pagination across resources
OpenAPI 3.1
Generated from the routes that actually run
Realtime ready
Websocket channels and platform webhooks
Start with a clear path.
The reference is broad. The way in is simple: understand the contract, bring a token, and make one small request before you build the whole workflow.
Authenticate once
Use a staff or patient Cognito bearer JWT, or an organization-scoped API key.
Read authentication →Reuse the conventions
Pagination, sorting, filtering, errors, and action responses stay predictable.
See the contract →A list is always a list.
Collection responses have one envelope. No cursors on one route, bare arrays on another, or totals that count something different from the returned items.
-
page1-based. Defaults to 1. -
pageSizeDefaults to 50. Minimum 1, maximum 100. -
countTotal matching items before pagination. -
dataThe current page, always as an array.
{
"count": 125,
"data": [
{ "id": "pat_7f2...", "firstName": "Jordan" }
],
"page": 1,
"pageSize": 50
}
Invalid page values return 400 BAD_REQUEST. Use sort=-createdAt
for descending fields and search for broad text matching.
Authentication
Access follows the person.
Send credentials in Authorization: Bearer <token>. Braver staff
users can access staff routes. Patient users can access only patient-scoped routes
for their linked record. Organization API keys stay scoped to their organization.
Start with the interactive reference, or bring the OpenAPI YAML into the client generator you already use.