Workspace API

Live rooms

Live rooms endpoints of the Zanfia Workspace API, with schemas and code samples.

2 min readLast updated Sep 30, 2026

Live rooms (Marketing → Live rooms): webinar rooms showing a stream or a recording locked to the clock, optionally as rolling sessions every N minutes (the just-in-time autowebinar). Read only — rooms are created and edited in the dashboard. Attendance counts real viewers by heartbeats while a session is on air; the replay is not attendance. All routes require a Authorization: Bearer header — see Authentication.

List live rooms

GET/live-rooms

Authorization

bearerAuth
AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/live-rooms"
{  "rooms": [    {      "id": "string",      "title": "string",      "description": "string",      "status": "scheduled",      "source": "youtube",      "startAt": "string",      "endAt": "string",      "timezone": "string",      "schedule": {        "everyMinutes": 0,        "until": "string"      },      "durationSeconds": 0,      "access": {        "everyone": true,        "productIds": [          "string"        ],        "communityIds": [          "string"        ]      },      "chatMode": "open",      "guestChat": "off",      "offer": {        "label": "string",        "url": "string",        "productId": "string",        "checkoutId": "string",        "atMinute": 0      },      "endedAt": "string",      "createdAt": "string",      "updatedAt": "string"    }  ]}
{  "error": "string",  "message": "string"}

Get room attendance

GET/live-rooms/{roomId}/attendance

Authorization

bearerAuth
AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

roomId*string

Query Parameters

session?string

ISO 8601 start of one session (a sessionStartAt of the summaries) whose attendee rows to include.

Formatdate-time

Response Body

application/json

application/json

curl -X GET "https://example.com/live-rooms/string/attendance"
{  "sessions": [    {      "sessionStartAt": "string",      "attendees": 0,      "identified": 0,      "averageWatchedSeconds": 0,      "watchedToEnd": 0,      "durationSeconds": 0    }  ],  "attendees": [    {      "attendee": "client",      "clientId": "string",      "displayName": "string",      "email": "string",      "firstSeenAt": "string",      "lastSeenAt": "string",      "watchedSeconds": 0,      "maxPositionSeconds": 0    }  ]}
{  "error": "string",  "message": "string"}

Was this article helpful?

Related articles

Spotted something off? Tell us at support@zanfia.com.