List Rooms
Lists Rooms you can open, optionally for one Business. Does not change a Room.
AuthorizationBearer <token>
Signed-in user's Supabase access token. Workspace-scoped operations also require SMB-Workspace-Id.
In: header
Query Parameters
business_id?string
Optional: 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
Optional: this Room's sub-rooms. Without it, sub-rooms list under their parent, or on their own for people who can't open the parent.
Match
^rom_[0-7][0-9A-HJKMNP-TV-Z]{25}$after?string
limit?integer
Range
1 <= value <= 100Default
20Header Parameters
SMB-Workspace-Id*string
Workspace where this operation runs. Required for user tokens and Workspace API keys.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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 } ], "has_more": true, "next_cursor": "string", "request_id": "string"}