Skip to main content

Bravely's API (By Request)

Pull clinic data from Bravely Connect — staff, clients, sessions, and more — using our early-access API.

Updated over 2 weeks ago

B.API (Bravely's API) allows you to securely access data from your Bravely Connect account, including staff, clients, appointments, invoices, and more. Designed for reporting, integration, and operational insight, B.API currently supports read-only access and is currently available upon request.

👋🏼 B.API is currently available by request. If you’d like access, get in touch and we’ll provide your API key and setup details.

Authentication

All requests must include your API key in the x-api-key header:

x-api-key: YOUR_API_KEY

This authenticates the request as your Bravely Connect account and returns data that your account has access to.

Base URL

All endpoints are accessible under the following base URL:

https://your-api-url.bravely.io/

(You’ll receive the actual URL when access is granted.)

Request Format

  • All endpoints use POST requests

  • All payloads and responses are in JSON unless otherwise specified

  • Each response includes an updatedAt timestamp, which you can use to request only new or changed data in future calls

Available Endpoints

getStaffs

Returns a list of all staff members in your clinic.

getClients

Returns a list of all clients in your clinic.

Each client includes a staffs array referring to the staff IDs from getStaffs.

getAppointments

Returns all appointments in your clinic.

Each appointment includes:

  • staffId

  • clientId

getSessionTypes

Returns all session types available in your clinic.

getInvoices

Returns a list of invoices. Supports optional filters:

  • mode: "Csv" or "Json"

  • startDate: ISO timestamp

  • endDate: ISO timestamp

  • filter: One of: ["All", "Paid", "Unpaid", "Overdue", "Partial", "Open"]

{
  "mode": "Json",           // or "Csv"
  "startDate": "2025-09-01T00:00:00Z",
  "endDate": "2025-09-30T23:59:59Z",
  "filter": "Unpaid",       // One of: All, Paid, Unpaid, Overdue, Partial, Open
  "updatedAt": "2025-09-25T16:43:18.536Z"
}

getTransactions

Returns a list of payment transactions.

Supports the same filtering options as getInvoices.

  • mode: "Csv" or "Json"

  • startDate: ISO timestamp

  • endDate: ISO timestamp

  • filter: One of: ["All", "Paid", "Unpaid", "Overdue", "Partial", "Open"]

Example Request

Here’s a sample curl request to fetch new invoices since a specific date:

curl -X POST 'https://your-api-url.bravely.com/getInvoices' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
    "mode": "Json",
    "updatedAt": "2025-09-25T16:43:18.536Z"
  }'

Notes

  • This API is intended for read-only data access at this stage.

  • All timestamps must be in ISO 8601 format (e.g. 2025-09-25T16:43:18.536Z).

  • The API is evolving — we welcome feedback as we develop more capabilities.

Need help or want to enable API access? Please contact us at [email protected]

Did this answer your question?