Webinar Registrants

Registrants of a webinar, with their live attendance

Info

Required scopes: stream.read

Warning

This method requires authentication

Retrieve a paginated list of the people who registered for a webinar event, oldest registration first. Each registrant includes whether they joined the webinar live. Registrants whose access was removed are not listed; they appear in the Webinar Registrants Download URL export.

curl -H "Authorization: Bearer [access token]" \
     https://api.restream.io/v2/user/events/{eventId}/webinar/registrants

Path Parameters:

Parameter	Type	Description
`eventId`	string (UUID)	The UUID of the event (required)

Query Parameters:

Parameter	Type	Description
`page`	integer	Page number, starting at `1`. Defaults to `1` (optional)
`perPage`	integer	Registrants per page, from `1` to `50`. Defaults to `50` (optional)

Request pages until page * perPage reaches totalCount to get every registrant.

Example request:

curl -H "Authorization: Bearer [access token]" \
     "https://api.restream.io/v2/user/events/{eventId}/webinar/registrants?page=2&perPage=50"

Response

Success

Error (event not found)

Error (invalid token)

{
  "registrants": [
    {
      "email": "jane@example.com",
      "name": "Jane Doe",
      "title": "Head of Marketing",
      "registeredAt": "2026-11-10T14:46:39.000Z",
      "attendedLive": true,
      "joinedAt": "2026-11-10T14:48:20.000Z",
      "attendanceStatus": "attended"
    },
    {
      "email": "john@example.com",
      "name": "John Smith",
      "title": null,
      "registeredAt": "2026-11-10T14:50:05.000Z",
      "attendedLive": null,
      "joinedAt": null,
      "attendanceStatus": null
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 50,
    "totalCount": 2
  }
}

Registrant fields:

Field	Type	Description
`email`	string	Registrant's email address
`name`	string \| null	Registrant's name
`title`	string \| null	Registrant's job title
`registeredAt`	string (ISO 8601)	When the person registered, in UTC
`attendedLive`	boolean \| null	`true` if the registrant joined the webinar live, otherwise `null`
`joinedAt`	string (ISO 8601) \| null	The registrant's most recent live join, in UTC
`attendanceStatus`	string \| null	`attended`, or `null` without an attendance record

Info

A null attendance means Restream has no attendance record for the registrant. Usually they did not join, but attendance can be missing for other reasons, such as webinars held before attendance tracking, so don't treat it as a confirmed no-show. Attendance is final only after the event has finished. New attendanceStatus values may be added, so handle unknown values.