Communication

Rooms

Video rooms, bookable room events, and their bookings. Read-only.

GET/rooms

List rooms

Returns the organization's video rooms. Read-only. Requires scope: rooms:read.

Parameters

Query

status
string
Return only rooms matching this status.

Response 200

No fields.

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
429Rate limited
500Unexpected server error
GET/rooms/{id}

Retrieve a room

Returns a single room by id. A record belonging to another organization returns 404 rather than 403. Requires scope: rooms:read.

Parameters

Path

idrequired
string

Response 200

FieldTypeDescription
id
string
object
string
name
string
status
string
nullable
participantCount
integer
A count rather than the participant list - the underlying array carries join metadata that serves no integration purpose.
activeSessionCount
integer
createdAt
string <date-time>
endedAt
string <date-time>
nullable

Errors

401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error
GET/room-events

List room events

Returns bookable room event types - the meeting types invitees can schedule. Read-only. Requires scope: rooms:read.

Parameters

Query

type
string
Return only room events matching this type.

Response 200

No fields.

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
429Rate limited
500Unexpected server error
GET/room-events/{id}

Retrieve a room event

Returns a single room event by id. A record belonging to another organization returns 404 rather than 403. Requires scope: rooms:read.

Parameters

Path

idrequired
string

Response 200

FieldTypeDescription
id
string
object
string
name
string
description
string
type
string
nullable
durationMinutes
integer
nullable
hostCount
integer
createdAt
string <date-time>
updatedAt
string <date-time>
nullable

Errors

401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error
GET/room-bookings

List room bookings

Returns scheduled room bookings, including who booked and when. Read-only. Requires scope: rooms:read.

Parameters

Query

roomId
string
Return only room bookings matching this roomId.

Response 200

No fields.

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
429Rate limited
500Unexpected server error
GET/room-bookings/{id}

Retrieve a room booking

Returns a single room booking by id. A record belonging to another organization returns 404 rather than 403. Requires scope: rooms:read.

Parameters

Path

idrequired
string

Response 200

FieldTypeDescription
id
string
object
string
name
string
The invitee's name.
email
string
The invitee's email address.
hostName
string
nullable
roomId
string
nullable
roomType
string
nullable
startAt
string
When the booking starts.nullable
durationMinutes
integer
nullable
inviteeTimezone
string
nullable
notes
string
createdAt
string <date-time>

Errors

401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error