Docs
REST API v1

Room object

Fields returned by the REST API for room object.

Fields

FieldTypeMeaning
idstringResource identifier.
projectIdstringOwning project.
environmentIdstringOwning environment.
namestringDisplay name.
metadataobjectApplication-defined JSON object.
statusstringLifecycle or delivery state.
maxParticipantsnumberRoom capacity.
createdAtstringCreation timestamp.
startedAtstring or nullStart timestamp, or null.
endedAtstring or nullEnd timestamp, or null.

Example

JSON
{
  "id": "room_example",
  "projectId": "project_example",
  "environmentId": "environment_example",
  "name": "Team call",
  "metadata": {},
  "status": "created",
  "maxParticipants": 100,
  "createdAt": "2026-01-01T12:00:00.000Z",
  "startedAt": null,
  "endedAt": null
}