Rooms API

A Room is public or private. In a public Room (the default), what’s said can come up with anyone in the workspace. In a private Room, it stays with the people in the Room. See Who hears what.

Requires the rooms:read scope to read and rooms:write to change a Room. Keys with full have both.

Room Object


{
  "id": "rooms_abc123",
  "name": "Leadership",
  "description": "Decisions for the leads",
  "audience": "private",
  "memberCount": 3,
  "createdAt": 1761139200000,
  "updatedAt": 1761139200000
}

Field Reference

Field	Type	Description
`id`	string	Unique identifier
`name`	string	1–100 characters
`description`	string	Up to 240 characters
`audience`	string	`public` (the default) or `private`
`memberCount`	number	People and agents in the Room
`createdAt`	number	Creation time, milliseconds since the epoch
`updatedAt`	number	Last change, milliseconds since the epoch

List Rooms


GET /api/v1/rooms

Returns the Rooms you’re in, most recently updated first, as { "data": [ ...rooms ] }.

Get a Room


GET /api/v1/rooms/{id}

Returns one Room you’re in. A Room you’re not in answers 404.

Update a Room


PATCH /api/v1/rooms/{id}


{ "audience": "private" }

Send any of name, description and audience. Unknown fields are refused with 400.

Only the workspace owner, an admin, or whoever created the Room can change audience; anyone else gets 403. The change applies to what’s said from then on. What was said before stays with the people it was said in front of.