VSee Clinic Visit API

Version 3.0 · Base URL https://api.vseepreview.com/api_v3 · 14 endpoints

The VSee Clinic Visit API allows developers to manage intakes, walk-in visits, e-consults, and appointments within the VSee Clinic platform.

Visit Status Codes

Visit Subtypes

Authentication

• X-ApiToken (header) — User access token obtained from login or SSO
• X-ApiKey (header) — API Key generated under Developers menu
• X-ApiSecret (header) — API Secret generated under Developers menu

Endpoints

Intakes

• post /intakes — Create intake data object
• post /intakes/{id} — Update intake data object
• get /intakes/{id} — Get intake data object

Walk-in Visits

• post /visits/add_walkin — Create a walk-in visit

E-consult Visits

• post /visits/add_econsult — Create an asynchronous e-consult visit

Appointments

• get /availability — Get provider's available slots
• post /visits — Create an appointment
• get /visits — List visits
• get /visits/{id} — Get visit detail
• post /visits/{id} — Update an appointment
• post /visits/close — Close or cancel a visit
• post /visits/delete — Force cancel a visit
• get /visits/current — Get current visit in progress

Visit Export

• get /visits/{id}/exports/visit_summary — Export visit summary

Machine-readable: OpenAPI JSON