v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Webinars and Sessions

List Sessions across Multiple Webinars/Hosts

Returns the list of Webinar Sessions hosted by all company users or particular user(s) sorted by 'scheduledStartTime' or 'creationTime' (if 'scheduledStartTime' is not set) in the ascending ordered. The user must have "WebinarSettings" permission granted otherwise the API returns HTTP 403.

get/webinar/configuration/v1/company/sessions

Query parameters

status'Scheduled' | 'Active' | 'Finished'

Session status (for the purposes of Configuration service)

Example:Scheduled

Filter to return only webinar sessions in certain status. Multiple values are supported.

endTimeFromstring date-time required

The beginning of the time window by 'endTime' (it is calculated as scheduledStartTime+scheduledDuration)

hostUserIdstring[]

Identifier of the user who hosts a webinar (if omitted, webinars hosted by all company users will be returned)

perPageinteger

The number of items per page. If provided value in the request is greater than a maximum, the maximum value is applied

pageTokenstring

The token indicating the particular page of the result set to be retrieved. If omitted the first page will be returned.

Response

Successful response

Example response

{
  "records": [
    {
      "id": "78654321",
      "webinar": {
        "id": "78654321",
        "title": "All-Hands Webinar",
        "description": "Quarterly All-hands event to present recent news about our company to employees"
      },
      "scheduledDuration": 1800,
      "timeZone": "America/New_York",
      "localizedTimeZoneDescription": "Eastern Time (America/New_York)",
      "panelJoinTimeOffset": 900,
      "title": "Live Broadcasting US",
      "description": "Live session for US-based participants",
      "status": "Scheduled",
      "hostJoinUri": "https://v.ringcentral.com/w/join/de7yd8ew7yfsdfjh899843rgj",
      "localeCode": "en-US"
    }
  ],
  "paging": {
    "perPage": 100
  }
}