Zoom Public API Documentation
Get a webinar
GET {{baseUrl}}/webinars/:webinarId?occurrence_id=<string>&show_previous_occurrences=<boolean>
Get details for a scheduled Zoom Webinar. Prerequisites:
* Pro or higher plan with a Webinar add-on. Scopes: Rate Limit Label: webinar:read:admin,webinar:readLIGHT
Body
PARAM
| Key | Datatype | Required | Description |
occurrence_id
|
string | Unique identifier for an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences. When you create a recurring Webinar using [**Create a webinar**](/docs/api-reference/zoom-api/methods#operation/webinarCreate) API, you can retrieve the Occurrence ID from the response of the API call. | |
show_previous_occurrences
|
string | Set the value of this field to `true` if you would like to view Webinar details of all previous occurrences of a recurring Webinar. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"host_email": "<email>",
"host_id": "<string>",
"id": "<long>",
"uuid": "<string>",
"agenda": "<string>",
"created_at": "<dateTime>",
"duration": "<integer>",
"join_url": "<string>",
"occurrences": [
{
"duration": "<integer>",
"occurrence_id": "<string>",
"start_time": "<dateTime>",
"status": "available"
},
{
"duration": "<integer>",
"occurrence_id": "<string>",
"start_time": "<dateTime>",
"status": "available"
}
],
"password": "<string>",
"encrypted_passcode": "<string>",
"h323_passcode": "<string>",
"recurrence": {
"type": 3,
"end_date_time": "<dateTime>",
"end_times": 1,
"monthly_day": "<integer>",
"monthly_week": 2,
"monthly_week_day": 7,
"repeat_interval": "<integer>",
"weekly_days": "<string>"
},
"settings": {
"allow_multiple_devices": "<boolean>",
"alternative_hosts": "<string>",
"alternative_host_update_polls": "<boolean>",
"approval_type": 2,
"attendees_and_panelists_reminder_email_notification": {
"enable": "<boolean>",
"type": 4
},
"audio": "both",
"audio_conference_info": "<string>",
"authentication_domains": "<string>",
"authentication_name": "<string>",
"authentication_option": "<string>",
"auto_recording": "none",
"close_registration": "<boolean>",
"contact_email": "<string>",
"contact_name": "<string>",
"email_language": "<string>",
"enforce_login": "<boolean>",
"enforce_login_domains": "<string>",
"follow_up_absentees_email_notification": {
"enable": "<boolean>",
"type": 4
},
"follow_up_attendees_email_notification": {
"enable": "<boolean>",
"type": 6
},
"global_dial_in_countries": [
"<string>",
"<string>"
],
"hd_video": false,
"hd_video_for_attendees": false,
"host_video": "<boolean>",
"language_interpretation": {
"enable": "<boolean>",
"interpreters": [
{
"email": "<email>",
"languages": "<string>"
},
{
"email": "<email>",
"languages": "<string>"
}
]
},
"sign_language_interpretation": {
"enable": "<boolean>",
"interpreters": [
{
"email": "<email>",
"sign_language": "<string>"
},
{
"email": "<email>",
"sign_language": "<string>"
}
]
},
"panelist_authentication": "<boolean>",
"meeting_authentication": "<boolean>",
"add_watermark": "<boolean>",
"add_audio_watermark": "<boolean>",
"notify_registrants": "<boolean>",
"on_demand": false,
"panelists_invitation_email_notification": "<boolean>",
"panelists_video": "<boolean>",
"post_webinar_survey": "<boolean>",
"practice_session": false,
"question_and_answer": {
"allow_submit_questions": "<boolean>",
"allow_anonymous_questions": "<boolean>",
"answer_questions": "all",
"attendees_can_comment": "<boolean>",
"attendees_can_upvote": "<boolean>",
"allow_auto_reply": "<boolean>",
"auto_reply_text": "<string>",
"enable": "<boolean>"
},
"registrants_confirmation_email": "<boolean>",
"registrants_email_notification": "<boolean>",
"registrants_restrict_number": 0,
"registration_type": 1,
"send_1080p_video_to_attendees": false,
"show_share_button": "<boolean>",
"survey_url": "<string>",
"enable_session_branding": "<boolean>"
},
"start_time": "<dateTime>",
"start_url": "<string>",
"timezone": "<string>",
"topic": "<string>",
"tracking_fields": [
{
"field": "<string>",
"value": "<string>"
},
{
"field": "<string>",
"value": "<string>"
}
],
"type": 5,
"is_simulive": "<boolean>",
"record_file_id": "<string>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/webinars/:webinarId?occurrence_id=<string>&show_previous_occurrences=<boolean>?occurrence_id=<string>&show_previous_occurrences=<boolean>' -H 'Accept: application/json'
ENDPOINTS