Rooms API

GET /rooms [public access] v3

Parameters

Parameter

Type

Description

Parameter

Type

Description

page

Integer

Page number for pagination

limit

Integer

Limit for pagination

Rooms API supports DataTable API

Response

curl -k -X GET -H "X-AccountCode: vclinic" "https://api.vsee.me/api_v3/rooms" { "data": [{ "slug": "room1", "name": "Room 1", "domain": "demo.vsee.me", "code": "room1_code", "created": 1427922788, "modified": 1427922788 }, ...] }

 

POST /rooms v3

Parameters

Parameter

Type

Description

Parameter

Type

Description

X-ApiToken

Header

Clinic Admin token (app token)

domain

String

Clinic’s domain

code

String

(optional) Room code (should be unique)

slug

String

(optional) Set this room as default, other rooms will lose default status.

name

String

Room's name

Response

curl --location --request POST 'https://api.vsee.me/api_v3/rooms' \ --header 'X-AccountCode: vclinic' \ --header 'X-ApiToken: 83ec6843c3af534c551ab609d869dd82' \ --form 'domain=vclinic.vsee.me' \ --form 'slug=provider00102' \ --form 'name=provider00102 room' { "data": { "visits": { "walkin": { "enabled": true }, "appointment": { "enabled": false } }, "auth": { "guest": { "type": 600, "log_in": { "enabled": true } } }, "subtitle": "If this is an emergency, please call 911.", "slug": "provider00102", "name": "provider00102 room", "domain": "vclinic.vsee.me", "active": true, "users": "85741", "account_code": "clinic", "provider_ids": [ "85741" ], "public_access_room": true, "modified": 1605728974, "created": 1605728974, "payment": { "consultations": [ { "id": "5fb57ace-4808-4346-ad3c-3348925862c1", "description": "15-min Consultation", "duration": 15, "amount": 0, "group": false, "charge": false, "slots": 1 } ], "currency": "USD", "__note__": "paymentCurrency will be deprecated by 1 Jun 2017" }, "operation_settings": { "is_closed": false, "close_msg": "Service currently not available. Please check back later", "default_timezone": "America/Los_Angeles" }, "id": "171", "code": "b4vjj" } }

If room already exists (http response code 400):

{ "code": 400, "message": "In domain 'vclinic.vsee.me' slug 'uat2' already exists." }

 

GET /rooms/:code [public access] v3v4

This API is available in both api v3 and v4

Parameters

(none)

Response

GET /rooms/:code/providers [public access] v3

Response

GET /rooms/:code/providers/:id [public access] v3

Response

GET /rooms/:code/queue [public access] v3

Waiting time = average_visit_time * before_me

Response

  • length - total current queue length

  • capacity- maximum possible queue length

  • average_visit_time - time in seconds per patient

  • before_me - patient in the queue before me

POST /users/:id/rooms v3

Associate a room to a user

Parameters

Parameter

Type

Description

Parameter

Type

Description

code

String

Room code

default

Boolean

(optional) Set this room as default, other rooms will lose default status.

Response

 

DELETE /users/:id/rooms/:room_code v3

Remove a room association with a user

Parameters

Parameter

Type

Description

Parameter

Type

Description

code

String

Room code

Response