Provider use case

Provider with Room

Set up multiple providers with their own dedicated waiting rooms. Each provider gets their own room to accept their own pool of patients.

Steps

1. Step 1: Obtain provider access token

   POST /users/sso · auth: API Key + Secret

   SSO the provider (type=400). Response includes data.id (user ID) for room assignment and data.token.token for redirect.

   headers:

   Field	Required	Description
   X-ApiKey	yes	API Key
   X-ApiSecret	yes	API Secret
   X-AccountCode	yes	Account code

   queryParams:

   Field	Required	Description
   fields	no	Set to 'vsee' to include VSee ID and token

   bodyFields:

   Field	Required	Description
   first_name	yes	Provider's first name
   last_name	yes	Provider's last name
   type	yes	User type: 400 = Provider
   email	no	Provider email address
   code	yes	Unique provider identifier on your end
   subtype	no	Provider subtype (e.g., 482 = Doctor, 470 = CSR)

2. Step 2: Create a waiting room

   POST /rooms · auth: Admin Token

   Create a dedicated room. Sends X-ApiKey, X-ApiSecret, and the Clinic Admin API Token together. Slug must be unique.

   headers:

   Field	Required	Description
   X-AccountCode	yes	Account code
   X-ApiKey	yes	API Key
   X-ApiSecret	yes	API Secret
   X-ApiToken	yes	Clinic Admin API Token from dashboard

   bodyFields:

   Field	Required	Description
   domain	yes	Clinic domain (auto-fills from stored Clinic URL)
   slug	yes	Unique room slug/identifier — developer-defined per room
   name	yes	Room display name — developer-defined per room

3. Step 3: Assign provider to the room

   POST /users/{id}/rooms · auth: Admin Token

   Link the room to the provider. Replace {id} with data.id from Step 1. Uses Admin Token.

   headers:

   Field	Required	Description
   X-ApiToken	yes	Clinic Admin API Token from dashboard
   X-AccountCode	yes	Account code

   pathParams:

   Field	Required	Description
   id	yes	Provider's user ID from Step 1

   bodyFields:

   Field	Required	Description
   code	yes	Room code from Step 2

4. Step 4: Redirect to provider dashboard

   Redirect to https://{your_clinic}.vseepreview.com/auth?sso_token={sso_token}&next=/providers/dashboard

   Redirect the provider to their dashboard where they'll see their dedicated room.