VSee Clinic API — Developer Portal
Interactive documentation for the VSee Clinic telehealth platform: 17 OpenAPI 3.0 specifications (89 endpoints), step-by-step guides, and interactive use cases. Authentication uses custom headers (X-ApiToken, X-AccountCode, X-ApiKey, X-ApiSecret), not Bearer tokens.
Guides
- Getting Started — Environments, onboarding, credentials, CORS, and common mistakes for integrating with the VSee Clinic API.
- Authentication — Token types (API key/secret, user token, admin token, account code) and the authentication decision flow for the VSee Clinic API.
- Error Reference — HTTP status codes and common error scenarios for the VSee Clinic API, and how to resolve them.
- Firewall Configuration — Network allowlist and firewall requirements for integrating with the VSee Clinic telehealth platform.
Interactive use cases
- Patient Dashboard — Log patient in and take them to VSee Clinic's patient dashboard where they can manage appointments, join video calls, and view visit history.
- Video Session — Log patient in using SSO, create an intake and walk-in visit, then redirect them directly into a video call with a provider.
- Appointment Scheduling — Log patient in using SSO, look up the room's consultation, create an intake, find an available time slot, then schedule the appointment.
- eConsult (Async Visit) — Log patient in using SSO, create an intake, then create an asynchronous e-consult.
- Guest Invite — Create a guest invite link to a video call.
- Provider Dashboard — Log a provider into VSee Clinic's provider dashboard for telehealth functionality — manage queue, accept visits, start video calls, view patient records.
- Provider with Room — Set up multiple providers with their own dedicated waiting rooms.
- Member SSO — Get an SSO token and inject it into your mobile app.
- Browser Call SDK — Use the VSee Browser Call SDK to embed video calling directly into your app.
API reference
- VSee Clinic User API — The VSee Clinic User API allows developers to manage users, authentication, and profiles within the VSee Clinic platform. (12 endpoints)
- VSee Clinic Visit API — The VSee Clinic Visit API allows developers to manage intakes, walk-in visits, e-consults, and appointments within the VSee Clinic platform. (14 endpoints)
- Visit Messages API — Asynchronous messaging on an eConsult visit: patients send and read messages through the API while providers reply from the VSee Clinic dashboard. (2 endpoints)
- VSee Clinic Rooms API — The VSee Clinic Rooms API allows developers to manage video consultation rooms within the VSee Clinic platform. (8 endpoints)
- Settings API — OpenAPI 3.0 specification. (2 endpoints)
- EMR API — OpenAPI 3.0 specification. (2 endpoints)
- Pharmacy API — OpenAPI 3.0 specification. (4 endpoints)
- Payment API — Payment is integrated with Stripe. (7 endpoints)
- Insurance API — The insurance CRUD APIs can be called using either a patient's token or a Clinic Admin token. (13 endpoints)
- Clinic Account API — OpenAPI 3.0 specification. (1 endpoint)
- Push Notification API — This API is primarily for mobile app push notification registration. (8 endpoints)
- File Upload API — OpenAPI 3.0 specification. (6 endpoints)
- Slot API — The Slot API provides time slot availability for scheduling appointments. (4 endpoints)
- Recordings API — The Recordings API uses the Visit API endpoints with special parameters to access visit recordings. (2 endpoints)
- Survey API — OpenAPI 3.0 specification. (1 endpoint)
- Health API (Beta) — Health data and device management API (2 endpoints)
- Webhooks — Webhook event documentation for VSee Clinic API (1 endpoint)
For AI & tools