BriooDocs
Dashboard

Health check-ups

Video consultations let you speak with a doctor from the comfort of home. Our team has done this many times, so you never have to guess.

9 min read Updated Oct 5, 2025 v2.1.8

Overview

We keep things simple, so you can focus on what matters to you. We work with most insurance providers and explain any costs upfront. We keep things simple, so you can focus on what matters to you.

Same-day appointmentsStart in minutes and get help from a real person whenever you need it.Certified specialistsThousands of patients already trust us, and we work hard to keep it that way.Online resultsOur team has done this many times, so you never have to guess.

Installation

Install the SDK with the package manager your project already uses. It needs Node 18 or newer.

terminal
$ npm install @brioo/sdk
terminal
$ yarn add @brioo/sdk
terminal
$ pnpm add @brioo/sdk
Using a server without Node? The same endpoints are available over plain HTTPS; see the API reference below.

Configuration

Our clinic is fully accessible, with free parking right outside. Modern equipment means faster diagnoses and more comfortable treatment. Create a file named brioo.config.json in the project root:

brioo.config.json
{
  "project": "brioo",
  "region": "eu-west",
  "categories": ["cardiology", "dental", "pediatrics"],
  "retries": 5,
  "timeoutMs": 10000,
  "webhooks": { "enabled": true }
}
OptionTypeDefaultDescription
projectstring-Your project key from the dashboard.
regionstring"us-east"Data centre closest to your patients.
retriesnumber3How often a failed call is retried.
timeoutMsnumber10000Time before a request is cancelled.
webhooks.enabledbooleanfalseSend events to your endpoint.

Your first request

Lab results arrive in your patient portal, usually within 48 hours.

  1. Create an API keyOpen the dashboard, choose Settings › API keys and copy a new secret key.
  2. Store it safelyKeep the key in an environment variable, never in your source code.
  3. Make the callRun the snippet below; it prints the first page of results.
index.js
import { Client } from "@brioo/sdk";

const client = new Client({ apiKey: process.env.API_KEY });

// list the newest services in one category
const page = await client.services.list({ category: "cardiology", limit: 20 });

for (const item of page.data) {
  console.log(item.name, item.price);
}
Heads up: test keys only return sample data. Switch to a live key before you go to production.

API reference

Every endpoint returns JSON and uses standard HTTP status codes.

GET/v1/servicesList services with paging and filters.
POST/v1/servicesCreate a new service.
PATCH/v1/services/{id}Update some fields of a service.
DELETE/v1/services/{id}Archive a service; it can be restored for 30 days.
response.json
{
  "data": [
    { "id": "service_1082", "name": "Vaccination", "price": 34 }
  ],
  "has_more": true
}

Troubleshooting

Family plans cover check-ups and vaccinations for everyone under one roof. Friendly people answer your questions quickly, by phone, chat or email.

We listen first, then build a plan around what you actually need. Children are welcome, and our paediatric team knows how to make them smile.

Every detail is handled by people who care about getting it right. Our specialists take time to listen and explain every step of your treatment.

Next steps

Friendly reminders make sure you never miss a check-up or a dose.

Was this page helpful?
All screens