Rooms

List rooms (paginated with filters)

GET
/api/v1/rooms

Authorization

tenant-api-key
x-api-key<token>

Tenant API key (backend only — never expose to a browser)

In: header

Query Parameters

page?number
Range1 <= value
Default1
limit?number
Range1 <= value <= 100
Default20
status?string

Filter by room status

Value in

  • "WAITING"
  • "ACTIVE"
  • "ENDED"
type?string

Filter by room type

Value in

  • "INSTANT"
  • "SCHEDULED"
  • "PERMANENT"
externalId?string

Filter by external entity ID

externalType?string

Filter by external type (e.g., "consultation")

createdByExternalId?string

Filter by creator external ID

search?string

Search room name (case-insensitive contains)

Response Body

curl -X GET "https://example.com/api/v1/rooms"
Empty