Rooms API

get /rooms

List rooms

Base URL https://api.vseepreview.com/api_v3 · operationId listRooms

Authentication: Account Code Only — Only requires the X-AccountCode header. No token needed.

Retrieve a list of rooms with pagination. This is a public endpoint.

Note: The Rooms API supports the DataTable API format for server-side pagination and filtering.

Parameters

Name	In	Type	Required	Enum	Default	Description
X-AccountCode	header	string	yes			Account code (e.g. vclinic)
page	query	integer	no			Page number for pagination (e.g. 1)
limit	query	integer	no			Number of records per page (e.g. 10)

Responses

200 — Successful response

success — List of rooms

{
  "data": [
    {
      "slug": "room1",
      "name": "Room 1",
      "domain": "demo.vsee.me",
      "code": "room1_code",
      "created": 1427922788,
      "modified": 1427922788
    },
    {
      "slug": "room2",
      "name": "Room 2",
      "domain": "demo.vsee.me",
      "code": "room2_code",
      "created": 1427922800,
      "modified": 1427922800
    }
  ]
}

Machine-readable: OpenAPI JSON (operationId: listRooms)