Zoom Meeting

The number of records returned within a single API call.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The query start date, in yyyy-MM-dd'T'HH:mm:ssZ format. This value and the to query parameter value cannot exceed seven days.

The query end date, in yyyy-MM-dd'T'HH:mm:ssZ format. This value and the from query parameter value cannot exceed seven days.

The type of query date.

• meeting_start_time
• archive_complete_time

This value defaults to meeting_start_time.

The group ID. To get a group ID, use the List groups API.

The query start date, yyyy-MM-dd'T'HH:mm:ssZ format. This value and the to query parameter value cannot exceed seven days.

The query end date, in yyyy-MM-dd'T'HH:mm:ssZ format. This value and the from query parameter value cannot exceed seven days.

The meeting’s universally unique identifier (UUID). Each meeting instance generates a UUID. After a meeting ends, a new UUID is generated for the next meeting instance.

If the meeting UUID begins with a / character or contains a // character, you must double encode the meeting UUID when using the meeting UUID for other API calls.

To get a meeting’s cloud recordings, provide the meeting ID or UUID. If providing the meeting ID instead of UUID, the response will be for the latest meeting instance.

To get a webinar’s cloud recordings, provide the webinar’s ID or UUID. If providing the webinar ID instead of UUID, the response will be for the latest webinar instance.

If a UUID starts with / or contains // (example: /ajXp112QmuoKj4854875==), double encode the UUID before making an API request.

The download_access_token value for downloading the meeting’s recordings.

The download_access_token Time to Live (TTL) value. This parameter is only valid if the include_fields query parameter contains the download_access_token value.

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

The number of records returned within a single API call.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The start date for the monthly range to query. The maximum range can be a month. If you do not provide this value, this defaults to the current date.

The end date for the monthly range to query. The maximum range can be a month.

The type of analytics details:

• by_view — by_view.
• by_download — by_download.

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

The start date for the monthly range to query. The maximum range can be a month. If you do not provide this value, this defaults to the current date.

The end date for the monthly range to query. The maximum range can be a month.

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

Query by the registrant’s status:

• pending — The registration is pending.
• approved — The registrant is approved.
• denied — The registration is denied.

The number of records returned within a single API call.

Deprecated. We will no longer support this field in a future release. Instead, use the next_page_token for pagination.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

The meeting ID enables you to get cloud recording of a:

• Meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

• Webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

The user’s ID or email address. For user-level apps, pass the me value.

The number of records returned within a single API call.

The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

The query metadata of the recording if using an on-premise meeting connector for the meeting.

The query trash.

• true - List recordings from trash.
• false - Do not list recordings from the trash.

The default value is false. If you set it to true, you can use the trash_type property to indicate the type of Cloud recording that you need to retrieve.

The start date in ‘yyyy-mm-dd’ UTC format for the date range where you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date.

For example, if you make the API request on June 30, 2020, without providing the from and to parameters, by default the value of ‘from’ field will be 2020-06-30 and the value of the ‘to’ field will be 2020-07-01.

Note: The trash files cannot be filtered by date range and thus, the from and to fields should not be used for trash files.

The end date in ‘yyyy-mm-dd’ ‘yyyy-mm-dd’ UTC format.

The type of cloud recording to retrieve from the trash.

• meeting_recordings: List all meeting recordings from the trash.
• recording_file: List all individual recording files from the trash.

The meeting ID.

Filter devices by name or serial number.

Filter devices by platform operating system.

Filter devices by enrollment of ZDM (Zoom Device Management).

Filter devices by device type.
Device Type:
-1 - All Zoom Room device(0,1,2,3,4,6).
0 - Zoom Rooms Computer.
1 - Zoom Rooms Controller.
2 - Zoom Rooms Scheduling Display.
3 - Zoom Rooms Control System.
4 - Zoom Rooms Whiteboard.
5 - Zoom Phone Appliance.
6 - Zoom Rooms Computer (with Controller).

Filter devices by vendor.

Filter devices by model.

Filter devices by status.
Device Status:
0 - offline.
1 - online.
-1 - unlink

The number of records returned within a single API call.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The total number of records returned from a single API call.
Default - 30.
Max -100.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period token is 15 minutes.

The Zoom Device Management (ZDM) group ID.

The device’s unique identifier.

The number of records returned within a single API call.

Deprecated. We will no longer support this field in a future release. Instead, use the next_page_token for pagination.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The number of records returned within a single API call.

The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

The start date in yyyy-MM-dd'T'HH:mm:ss'Z' UTC format used to retrieve the creation date range of the meeting summaries.

The end date in yyyy-MM-dd'T'HH:mm:ss'Z' UTC format used to retrieve the creation date range of the meeting summaries.

The meeting’s ID.

When storing this value in your database, store it as a long format integer and not an integer. Meeting IDs can be more than 10 digits.

Meeting occurrence ID. Provide this field to view meeting details of a particular occurrence of the recurring meeting.

Set this field’s value to true to view meeting details of all previous occurrences of a recurring meeting.

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

Whether to bypass the waiting room.

Unique identifier of the meeting.

The meeting’s universally unique ID (UUID). When you provide a meeting UUID that begins with a / character or contains the // characters, you must double-encode the meeting UUID before making an API request.

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

Whether to query for polls with the Anonymous option enabled:

• true — Query for polls with the Anonymous option enabled.
• false — Do not query for polls with the Anonymous option enabled.

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

The poll ID

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

The meeting or webinar occurrence ID.

Query by the registrant’s status.

• pending - The registration is pending.
• approved - The registrant is approved.
• denied - The registration is denied.

The number of records returned within a single API call.

Deprecated. We will no longer support this field in a future release. Instead, use the next_page_token for pagination.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

The registrant ID.

The meeting’s ID.

When storing this value in your database, store it as a long-format integer and not a simple integer. Meeting IDs can be more than 10 digits.

The meeting’s ID.

When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.

The meeting token type:

• closed_caption_token — The third-party closed caption API token.

This defaults to closed_caption_token.

The meeting’s ID or universally unique ID (UUID).

• If you provide a meeting ID, the API will return a response for the latest meeting instance.
• If you provide a meeting UUID that begins with a / character or contains the // characters, you must double encode the meeting UUID before making an API request.

The past meeting’s ID.

The meeting’s ID or universally unique ID (UUID).

• If you provide a meeting ID, the API will return a response for the latest meeting instance.
• If you provide a meeting UUID that begins with a / character or contains the // characters, you must double-encode the meeting UUID before making an API request.

The number of records returned within a single API call.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The meeting’s ID or universally unique ID (UUID).

• If you provide a meeting ID, the API will return a response for the latest meeting instance.
• If you provide a meeting UUID that begins with a / character or contains the // characters, you must double-encode the meeting UUID before making an API request.

The meeting’s ID or universally unique ID (UUID).

• If you provide a meeting ID, the API will return a response for the latest meeting instance.
• If you provide a meeting UUID that begins with a / character or contains the // characters, you must double-encode the meeting UUID before making an API request.

The user ID retrievable from the List users API.

The user’s user ID or email address. For user-level apps, pass the me value.

The type of meeting.

• scheduled - All valid previous (unexpired) meetings, live meetings, and upcoming scheduled meetings.
• live - All the ongoing meetings.
• upcoming - All upcoming meetings, including live meetings.
• upcoming_meetings - All upcoming meetings, including live meetings.
• previous_meetings - All the previous meetings.

The number of records returned within a single API call.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The page number of the current page in the returned records.

The start date.

The end date.

The timezone to assign to the from and to value. For a list of supported timezones and their formats, see our timezone list.

The user’s user ID or email address. For user-level apps, pass the me value.

The user’s user ID or email address. For user-level apps, pass the me value.

Start date for which you would like to view the activity logs report. Using the from and to parameters, specify a monthly date range for the report as the API only provides one month worth of data in one request. The specified date range should fall within the last six months.

End date up to which you would like to view the activity logs report.

The number of records to be returned within a single API call

Next page token is used to paginate through large result sets

Unique Identifier of the Billing Report. Retrieve this ID from the response of Get Billing Reports API request.

Start date in ‘yyyy-mm-dd’ format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

End date.

The group ID. To get a group ID, use the List groups API.

Note: The API response will only contain users who are members of the queried group ID.

Year for this report

Month for this report

The group ID. To get a group ID, use the List groups API.

Note: The API response will only contain users who are members of the queried group ID.

The meeting’s ID or universally unique ID (UUID).

• If you provide a meeting ID, the API will return a response for the latest meeting instance.
• If you provide a meeting UUID that begins with a / character or contains the // characters, you must double encode the meeting UUID before making an API request.

The meeting’s ID or universally unique ID (UUID).

• If you provide a meeting ID, the API will return a response for the latest meeting instance.
• If you provide a meeting UUID that begins with a / character or contains the // characters, you must double-encode the meeting UUID before making an API request.

The number of records returned within a single API call.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

Provide registrant_id as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a meeting registrant.

The meeting’s ID or universally unique ID (UUID).

• If you provide a meeting ID, the API will return a response for the latest meeting instance.
• If you provide a meeting UUID that begins with a / character or contains the // characters, you must double encode the meeting UUID before making an API request.

The meeting’s ID or universally unique ID (UUID).

• If you provide a meeting ID, the API will return a response for the latest meeting instance.
• If you provide a meeting UUID that begins with a / character or contains the // characters, you must double-encode the meeting UUID before making an API request.

The meeting’s ID or universally unique ID (UUID).

• If you provide a meeting ID, the API will return a response for the latest meeting instance.
• If you provide a meeting UUID that begins with a / character or contains the // characters, you must double-encode the meeting UUID before making an API request.

Start date in ‘yyyy-mm-dd’ format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

End date.

The number of records returned within a single API call.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

Optional

Filter your response by a category type to see reports for a specific category.
The value for this field can be one of the following:
all
user
user_settings
account
billing
im
recording
phone_contacts
webinar
sub_account
role
zoom_rooms

Audio types:
1 - Toll-free Call-in & Call-out.
2 - Toll

3 - SIP Connected Audio

The type of date to query.

• start_time — Query by call start time.
• end_time — Query by call end time.
• meeting_start_time — Query by meeting start time.
• meeting_end_time — Query by meeting end time.

This value defaults to start_time.

Start date in ‘yyyy-mm-dd’ format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

End date.

The number of records returned within a single API call.

The page number of the current page in the returned records. This field is not available if the query_date_type parameter is the meeting_start_time or meeting_end_time value.

This field is deprecated. Use the next_page_token query parameter for pagination.

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Start date in ‘yyyy-mm-dd’ format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

End date.

The number of records returned within a single API call.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The type of event to query.

• meeting — A meeting event.
• webinar — A webinar event.
• all — Both meeting and webinar events.

This value defaults to all.

The group ID. To get a group ID, use the List groups API.

Note: The API response will only contain meetings where the host is a member of the queried group ID.

Active or inactive hosts.
active - Active hosts.
inactive - Inactive hosts.

Start date in ‘yyyy-mm-dd’ format. The date range defined by the from and to parameters should only be one month as the report includes only one month worth of data at once.

End date.

The number of records returned within a single API call.

The page number of the current page in the returned records.

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

The group ID. To get a group ID, use the List groups API.

Note: The API response will only contain users who are members of the queried group ID.

The user ID or email address of the user. For user-level apps, pass the me value.

Start date in ‘yyyy-mm-dd’ format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

End date.

The number of records returned within a single API call.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The meeting type to query for:

• past — All past meetings.
• pastOne — A single past user meeting.
• pastJoined — All past meetings the account’s users hosted or joined.

The webinar’s ID or universally unique ID (UUID).

• If you provide a webinar ID, the API will return a response for the latest webinar instance.
• If you provide a webinar UUID that begins with a / character or contains the // characters, you must double encode the webinar UUID before making an API request.

The webinar’s ID or universally unique ID (UUID).

• If you provide a webinar ID, the API will return a response for the latest webinar instance.
• If you provide a webinar UUID that begins with a / character or contains the // characters, you must double-encode the webinar UUID before making an API request.

The number of records returned within a single API call.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The additional query parameters to include.

• registrant_id - Include the registrant’s ID in the API response. The registrant ID is the webinar participant’s unique ID.

The webinar’s ID or universally unique ID (UUID).

• If you provide a webinar ID, the API will return a response for the latest webinar instance.
• If you provide a webinar UUID that begins with a / character or contains the // characters, you must double-encode the webinar UUID before making an API request.

The webinar’s ID or universally unique ID (UUID).

• If you provide a webinar ID, the API will return a response for the latest webinar instance.
• If you provide a webinar UUID that begins with a / character or contains the // characters, you must double-encode the webinar UUID before making an API request.

The webinar’s ID or universally unique ID (UUID).

• If you provide a webinar ID, the API returns a response for the latest webinar instance.
• If you provide a webinar UUID that begins with a / character or contains the // characters, you must double-encode the webinar UUID before making an API request.

Deprecated. We will no longer support this field in a future release. Instead, use the next_page_token for pagination.

User name or email address of a user. If this parameter is provided, only the SIP phone system integration enabled for that specific user will be returned. Otherwise, all SIP phones on an account will be returned.

The number of records returned within a single API call.

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

The user ID or email address of the user. For user-level apps, pass the me value.

The user ID or email address of the user. For user-level apps, pass the me value.

TSP account ID.

The Tracking Field ID

The webinar’s ID or universally unique ID (UUID).

Unique identifier for an occurrence of a recurring webinar. Recurring webinars can have a maximum of 50 occurrences. When you create a recurring Webinar using Create a webinar API, you can retrieve the Occurrence ID from the response of the API call.

Set the value of this field to true if you would like to view Webinar details of all previous occurrences of a recurring Webinar.

The webinar’s ID.

The webinar’s ID.

The webinar’s ID.

The webinar’s ID.

The webinar’s unique ID.

The webinar’s ID.

The webinar’s ID.

Whether to query for polls with the Anonymous option enabled:

• true — Query for polls with the Anonymous option enabled.
• false — Do not query for polls with the Anonymous option enabled.

The webinar’s ID.

The poll ID

The webinar’s ID.

The meeting or webinar occurrence ID.

Query by the registrant’s status.

• pending - The registration is pending.
• approved - The registrant is approved.
• denied - The registration is denied.

The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations. See Creating source tracking links for webinar registration for details.

The number of records returned within a single API call.

Deprecated This field will be deprecated. We will no longer support this field in a future release. Instead, use the next_page_token for pagination.

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

The webinar’s ID.