VSee Clinic Rooms API

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

The VSee Clinic Rooms API allows developers to manage video consultation rooms within the VSee Clinic platform.

Room Codes

Every room has a unique code (e.g., my-room-123). The room code is used to identify the room in API calls (e.g., PUT /rooms/{code}) and to construct the room URL for joining: https://{account_code}.vsee.me/{room_code}.

When creating a room, you can optionally specify a code. If omitted, the system generates one automatically. Room codes must be unique within your clinic.

Authentication

Reading rooms (GET /rooms, GET /rooms/{code}) requires only the X-AccountCode header. Creating, updating, or deleting rooms requires the Clinic Admin API Token in the X-ApiToken header — not a user session token.

Endpoints

Rooms

• get /rooms — List rooms
• post /rooms — Create room
• get /rooms/{code} — Get room details

Room Providers

• get /rooms/{code}/providers — List room providers
• get /rooms/{code}/providers/{id} — Get room provider detail

Room Queue

• get /rooms/{code}/queue — Get room queue info

User Rooms

• post /users/{id}/rooms — Associate room to user
• delete /users/{id}/rooms/{room_code} — Remove room from user

Machine-readable: OpenAPI JSON