Beta

List Rooms

Last updated Nov 19, 2026View as MarkdownAgent setup / MCP
GET
/v1/rooms

Lists Rooms you can open, for one Business, by name or by ID. Does not change a Room.

Authorization

headerAuthorizationBearer <token>

A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.

Query Parameters

business_id?string

Only Rooms for or pointing at this Business.

Match^biz_[0-7][0-9A-HJKMNP-TV-Z]{25}$
status?string
Value in"active""archived"
parent_room_id?string

Only this Room's sub-rooms. Without it, sub-rooms list under their parent (alone if you can't open it).

Match^rom_[0-7][0-9A-HJKMNP-TV-Z]{25}$
query?string

Title contains this text (sub-rooms too).

Length1 <= length <= 200
room_ids?array<>

Only these Rooms.

Items1 <= items <= 100
include?"people"

people: add each Room's people, people_count and waiting_on (who has open tasks).

Value in"people"
after?string
limit?integer
Range1 <= value <= 100
Default20

Header Parameters

SMB-Workspace-Id*string

Workspace where this operation runs. Required for user tokens and Workspace API keys.

Formatuuid

Response Body

Successful authorized response.

application/json
  1. response
rooms*array<>
has_more*smb_v0_operations_create_list_request.__local.properties.body.__schema16
next_cursor*string|null
request_id*string
curl -X GET 'https://example.com/v1/rooms' \  -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "rooms": [    {      "room_id": "string",      "business_id": "string",      "title": "string",      "purpose": "string",      "status": "active",      "revision": 1,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "archived_at": "2019-08-24T14:15:22Z",      "access_level": "view",      "general_access": "business",      "general_access_level": "view",      "attachments": [        {          "attachment_id": "string",          "type": "business",          "id": "string",          "label": "string",          "attached_at": "2019-08-24T14:15:22Z"        }      ],      "parent": {        "room_id": "string",        "title": "string"      },      "sub_room_count": 0,      "can_be_starting_room": true,      "settings": {        "who_can_invite": "full_access",        "custom_branding": true,        "brand_logo_url": "string",        "smb_agent": {},        "outside_apps": {},        "locks": [          "string"        ],        "effective": {          "smb_agent": {},          "outside_apps": {},          "locked_by_parent": [            "string"          ]        },        "parent_effective": {}      },      "url": "http://example.com",      "people": [        {          "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",          "email": "string",          "name": "string",          "avatar_url": "string",          "role": "view"        }      ],      "people_count": 0,      "waiting_on": [        {          "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",          "email": "string",          "name": "string",          "avatar_url": "string",          "role": "view"        }      ]    }  ],  "has_more": true,  "next_cursor": "string",  "request_id": "string"}