The Zoom API is a RESTful interface that enables programmatic management of Zoom platform resources—including accounts and sub‑accounts, users, meetings, webinars, recordings, chat bot messages, Zoom Rooms locations, phone and SIP trunk settings, and various usage and billing metrics.
message_id(path, required) — Unique Identifier of the message that needs to be updated. This should be retrieved from the response of [Send Chatbot Message API](https://marketplace.zoom.us/docs/api-reference/zoom-api/im-chat/sendchatbot).
GET
/webinars/{webinarId}/polls/{pollId}
Get a webinar poll
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
pollId(path, required) — The poll ID
GET
/rooms/locations/{locationId}
Get Zoom Room location profile
locationId(path, required) — Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).
PATCH
/rooms/locations/{locationId}
Update Zoom Room location profile
locationId(path, required) — Unique Identifier of the location. This can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.
PUT
/rooms/locations/{locationId}/location
Change the assigned parent location
locationId(path, required)
PUT
/webinars/{webinarId}/polls/{pollId}
Update a webinar poll
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
pollId(path, required) — The poll ID
GET
/metrics/client/satisfaction
List client meeting satisfaction
from(query) — The start date for the query in “yyyy-mm-dd” format.
to(query) — The end date for the query in “yyyy-mm-dd” format.
POST
/webinars/{webinarId}/panelists
Add panelists
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
DELETE
/webinars/{webinarId}/panelists/{panelistId}
Remove a panelist
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
panelistId(path, required) — The panelist ID or panelist email.
GET
/accounts
List sub accounts
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
next_page_token(query) — 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.
POST
/accounts
Create a sub account
DELETE
/accounts/{accountId}
Disassociate a sub account
accountId(path, required) — The account ID.
GET
/accounts/{accountId}
Get sub account details
accountId(path, required) — The account ID.
GET
/accounts/{accountId}/billing
Get billing information
accountId(path, required) — The account ID.
PATCH
/accounts/{accountId}/billing
Update billing information
accountId(path, required) — The account ID.
GET
/accounts/{accountId}/billing/invoices
List billing invoices
from(query) — Start date for the invoice query in `yyyy-mm-dd` format. The date range defined by the “from” and “to” parameters should not exceed one year. The range defined should fall within the past three years.
to(query) — End date for the invoice query in `yyyy-mm-dd` format
accountId(path, required) — Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide "me" as the value of this field. To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.
option(query) — `meeting_security`: Use this query parameter to view meeting security settings applied on the account.
custom_query_fields(query) — Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video”).
PATCH
/accounts/{accountId}/lock_settings
Update locked settings
accountId(path, required) — Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide "me" as the value of this field. To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.
GET
/accounts/{accountId}/managed_domains
Get managed domains
accountId(path, required) — Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide "me" as the value of this field. To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.
PATCH
/accounts/{accountId}/options
Update options
accountId(path, required) — The account ID.
PUT
/accounts/{accountId}/owner
Update the account owner
accountId(path, required) — Account Id of the account.
PATCH
/accounts/{accountId}/phone/settings
Update BYOC settings
accountId(path, required) — Unique identifier of the sub account.
POST
/accounts/{accountId}/phone/setup
Set up a Zoom Phone account
accountId(path, required) — Unique identifier of the account.
POST
/accounts/{accountId}/phone/sip_trunk/trunks
Assign SIP trunks
accountId(path, required) — Unique identifier of the account.
sipTrunkId(path, required) — Unique identifier of the SIP trunk.
accountId(path, required) — Unique identifier of the sub account.
GET
/metrics/crc
Get CRC port usage
from(query, required) — 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.
autoReceptionistId(path, required) — Unique Identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites).
autoReceptionistId(path, required) — Unique identifier of the auto receptionist. This can be retrieved from the List Phone Sites API.
phoneNumberId(path, required) — Unique Identifier of the phone number or provide the actual phone number in e164 format (example: +19995550123).
DELETE
/meetings/{meetingId}/recordings
Delete meeting recordings
meetingId(path, required) — 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.
action(query) — The recording delete actions: `trash` - Move recording to trash. `delete` - Delete recording permanently.
PATCH
/meetings/{meetingId}/recordings/settings
Update meeting recording settings
meetingId(path, required) — 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.
accountId(path, required) — Unique Identifier of the account. To delete an internal number from a sub account, provide the account ID of the sub account in the `accountId` path parameter. To delete an internal number from a master account, provide `me` as the value of the `accountId` path parameter.
numberId(path, required) — Unique identifier of the phone number. This value can be retrieved by calling the List Internal Numbers API.
DELETE
/accounts/{accountId}/sip_trunk/numbers
Delete all numbers
accountId(path, required) — Account ID of the sub account from which the numbers are to be deleted. This can be retrieved from [List sub accounts](https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/account) API.
POST
/accounts/{accountId}/sip_trunk/numbers
Assign numbers
accountId(path, required) — Unique Identifier of the sub account.
callQueueId(path, required) — Unique Identifier of the Call Queue. This can be retrieved from the List Call Queues API.
phoneNumberId(path, required) — Unique Identifier of the Phone Number.
GET
/accounts/{accountId}/sip_trunk/trunks
List SIP trunks
accountId(path, required) — Unique Identifier of the Account. To retrieve SIP trunks assigned to a sub account, provide the account ID of the sub account in the as the value of this field. To retrieve SIP trunks of a master account, provide `me` as the value of this field.
POST
/accounts/{accountId}/sip_trunk/trunks
Assign SIP trunks
accountId(path, required) — Unique Identifier of the sub account.
DELETE
/accounts/{accountId}/sip_trunk/trunks/{trunkId}
Delete a SIP trunk
accountId(path, required) — Unique identifier of the sub account.
trunkId(path, required) — Unique identifier of the SIP Trunk that was previously assigned to a sub account. To retrieve the value of this field, use the List SIP Trunks API.
GET
/accounts/{accountId}/trusted_domains
Get trusted domains
accountId(path, required) — The account ID.
PUT
/accounts/{accountId}/users/{userId}/account
Switch a user's account
accountId(path, required)
GET
/api/download/billing/invoices/{invoiceId}
Download an invoice file
GET
/phone/sites/{siteId}
Get phone site details
siteId(path, required) — Unique Identifier of the Site.
PATCH
/chat/users/{userId}/channels/{channelId}
Update a channel
channelId(path, required) — Channel Id.
userId(path, required) — Unique Identifier of the Zoom user who is the owner of the channel.
PUT
/meetings/{meetingId}/recordings/status
Recover meeting recordings
meetingId(path, required) — 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.
GET
/im/chat/sessions
Get IM chat sessions
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
GET
/metrics/client/feedback
List Zoom meetings client feedback
from(query, required) — 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.
to(query, required) — End date.
GET
/metrics/client/feedback/{feedbackId}
Get zoom meetings client feedback
feedbackId(path, required) — Feedback Detail Id
from(query)
to(query)
page_size(query, limit)
next_page_token(query)
DELETE
/meetings/{meetingId}
Delete a meeting
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
occurrence_id(query) — The meeting occurrence ID.
schedule_for_reminder(query) — `true`: Notify host and alternative host about the meeting cancellation via email. `false`: Do not send any email notification.
cancel_meeting_reminder(query) — `true`: Notify registrants about the meeting cancellation via email. `false`: Do not send any email notification to meeting registrants. The default value of this field is `false`.
PATCH
/phone/sites/{siteId}
Update phone site details
siteId(path, required) — Unique Identifier of the Site.
DELETE
/meetings/{meetingId}/polls/{pollId}
Delete a meeting poll
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
pollId(path, required) — The poll ID
GET
/meetings/{meetingId}/polls/{pollId}
Get a meeting poll
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
pollId(path, required) — The poll ID
GET
/chat/users/{userId}/channels/{channelId}/members
List channel members
channelId(path, required) — Channel Id.
page_size(query, limit) — The number of records returned with a single API call.
next_page_token(query) — 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.
userId(path, required) — Unique identifier of the user who is the owner of this channel.
POST
/chat/users/{userId}/channels/{channelId}/members
Invite channel members
channelId(path, required) — Channel ID: Unique Identifier of the channel.
userId(path, required) — Unique identifier of the user who is the owner of this channel.
channelId(path, required) — Unique Identifier of the Channel from where you would like to remove a member. This can be retrieved from the [List Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).
memberId(path, required) — Email address of the member whom you would like to be remove from the channel.
userId(path, required) — Unique identifier of the channel owner.
PATCH
/groups/{groupId}/lock_settings
Update locked settings
groupId(path, required) — The Id of the group.
option(query) — Specify `meeting_security` as the value of this field if you would like to view security settings applied on a meeting hosted by the users in this group.
PUT
/meetings/{meetingId}/polls/{pollId}
Update a meeting poll
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
pollId(path, required) — The poll ID
GET
/accounts/{accountId}/recordings
List recordings of an account
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
from(query) — The start date in UTC for the monthly range for which 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”.
to(query) — The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month.
accountId(path, required) — Unique identifier of the account.
GET
/accounts/{accountId}/settings
Get settings
accountId(path, required) — The account ID.
option(query) — `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account. `recording_authentication`: Use this query parameter to view [recording authentication configuration](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account. `security`: Use this query parameter to view security settings such as password requirements for user login, two factor authentication etc., applied on the account. `meeting_security`: Use this query parameter to view meeting security settings applied on the account.
custom_query_fields(query) — Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video”).
accountId(path, required) — Unique identifier of the account.
GET
/accounts/{accountId}/sip_trunk/callout_countries
List internal call-out countries
accountId(path, required) — Unique identifier of the account. To list Call-out enabled countries to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To list Call-out enabled countries of a sub account, provide the account ID of the sub account in the `accountId` path parameter. To list Call-out enabled countries of a master account, provide `me` as the value of the `accountId` path parameter.
POST
/accounts/{accountId}/sip_trunk/callout_countries
Add internal call-out countries
accountId(path, required) — Unique identifier of the account. To add Call-out enabled countries to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add Call-out enabled countries to a master account, provide `me` as the value of the `accountId` path parameter.
accountId(path, required) — Unique Identifier of the Account. To remove Call-out country from a sub account, provide the account ID of the sub account in the `accountId` path parameter. To remove Call-out country from a master account, provide `me` as the value of the `accountId` path parameter.
countryId(path, required) — Two lettered Id of the country.
GET
/accounts/{accountId}/sip_trunk/internal_numbers
List internal numbers
accountId(path, required) — Unique identifier of the account. To list internal numbers of a sub account, provide the account ID of the sub account in the `accountId` path parameter. To list internal numbers of a master account, provide `me` as the value of the `accountId` path parameter.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
POST
/accounts/{accountId}/sip_trunk/internal_numbers
Add internal numbers
accountId(path, required) — Unique identifier of the account. To add internal numbers to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add internal numbers to a master account, provide `me` as the value of the `accountId` path parameter.
GET
/archive_files
List archived files
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
from(query) — Start date for the query in "yyyy-MM-dd'T'HH:mm:ss'Z'" format. The duration for the query defined using the "from" and "to" parameters should not exceed 7 days as this API only provides a week's data at once.
to(query) — End date for the query in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.
query_data_type(query) — Query data type for `from` and `to`.
DELETE
/chat/channels/{channelId}
Delete a channel
channelId(path, required) — Channel ID: Unique Identifier of a channel.
GET
/chat/channels/{channelId}
Get a channel
channelId(path, required) — Channel ID: Unique Identifier of a channel.
PATCH
/chat/channels/{channelId}
Update a channel
channelId(path, required) — Channel Id.
DELETE
/chat/channels/{channelId}/members/me
Leave a channel
channelId(path, required) — Channel ID: Unique Identifier of a channel.
POST
/chat/channels/{channelId}/members/me
Join a channel
channelId(path, required) — Channel Id.
DELETE
/chat/channels/{channelId}/members/{memberId}
Remove a member
channelId(path, required) — Unique Identifier of the Channel from where you would like to remove a member. This can be retrieved from the [List Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).
memberId(path, required) — Email address of the member whom you would like to be remove from the channel.
GET
/chat/users/me/contacts
List user's contacts
type(query) — The type of contact. The value can be one of the following: `company`: Contacts from the user's organization. `external`: External contacts.
page_size(query, limit) — The number of records returned with a single API call.
next_page_token(query) — 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.
GET
/chat/users/me/contacts/{contactId}
Get user's contact details
contactId(path, required) — The user's contact Id or email address. The contact can be either a company contact or an external contact.
query_presence_status(query) — The presence status of the contact. Include this query parameter with a value of `true` to get the presence status of the contact in the response.
GET
/chat/users/{userId}/channels
List user's channels
page_size(query, limit) — The number of records returned from a single API call.
next_page_token(query) — The next page token is used to paginate through large result sets. The expiration period for this token is 15 minutes.
userId(path, required) — Unique identifier of the user.
POST
/chat/users/{userId}/channels
Create a channel
userId(path, required) — Unique identifier of the user.
DELETE
/chat/users/{userId}/channels/{channelId}
Delete a channel
channelId(path, required) — Channel ID: Unique Identifier of a channel.
GET
/chat/users/{userId}/channels/{channelId}
Get a channel
channelId(path, required) — Channel ID: Unique Identifier of a channel.
userId(path, required) — Unique identifier of the user who is the owner of the channel.
POST
/h323/devices
Create a H.323/SIP device
GET
/chat/users/{userId}/messages
List user's chat messages
to_contact(query) — The email address of a chat contact with whom the current user chatted. Messages that were sent and/or received between the user and the contact is displayed. Note: You must provide either `contact` or `channel` as a query parameter to retrieve messages either from an individual or a chat channel.
to_channel(query) — The channel Id of a channel inside which the current user had chat conversations. Messages that were sent and/or received between the user and the channel is displayed. Note: You must provide either `contact` or `channel` as a query parameter to retrieve messages either from an individual or a chat channel.
date(query) — The query date for which you would like to get the chat messages.
page_size(query, limit) — The number of records returned with a single API call.
next_page_token(query) — 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.
include_deleted_and_edited_message(query) — **Optional** Set the value of this field to `true` to include edited and deleted messages in the response.
POST
/chat/users/{userId}/messages
Send a chat message
DELETE
/chat/users/{userId}/messages/{messageId}
Delete a message
messageId(path, required) — Message ID
to_contact(query) — The userId or email address of a chat contact to whom you previously sent the message. Note: You must provide either `to_contact` or `to_channel` as a query parameter to delete a message that was previously sent to either an individual or a chat channel respectively.
to_channel(query) — The channel Id of the channel where you would like to send the message. You must provide either `to_contact` or `to_channel` as a query parameter to delete a message that was previously sent to either an individual or a chat channel
PUT
/chat/users/{userId}/messages/{messageId}
Update a message
messageId(path, required) — Message ID: Unique Identifier of the message.
GET
/contacts
Search company contacts
search_key(query, required) — Provide the keyword - either first name, last name or email of the contact whom you have to search for.
query_presence_status(query) — Set `query_presence_status` to `true` in order to include the presence status of a contact in the response.
page_size(query, limit) — The number of records to be returned with a single API call.
next_page_token(query) — 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.
GET
/groups
List groups
POST
/groups
Create a group
DELETE
/groups/{groupId}
Delete a group
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
GET
/groups/{groupId}
Get a group
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
PATCH
/groups/{groupId}
Update a group
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
GET
/groups/{groupId}/lock_settings
Get locked settings
groupId(path, required) — Id of the group.
option(query) — Specify `meeting_security` as the value of this field if you would like to view security settings applied on a meeting hosted by the users in this group.
GET
/groups/{groupId}/members
List group members
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
next_page_token(query) — 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.
POST
/groups/{groupId}/members
Add group members
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
DELETE
/groups/{groupId}/members/{memberId}
Delete a group member
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
memberId(path, required) — The member ID.
PATCH
/groups/{groupId}/members/{memberId}
Update a group member
groupId(path, required) — Unique Identifier of the group. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API. To change a member's primary group, provide the groupId of the member's current primary group as the value of this field. To remove a member from one group and move the member to another group, provide the groupId of the group from which the member is to be moved.
memberId(path, required) — Unique Identifier of the group member. Can be retrieved by calling the [List Group Members](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groupmembers) API.
GET
/groups/{groupId}/settings
Get a group's settings
option(query) — `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the group. `recording_authentication`: Use this query parameter to view [recording authentication configuration](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the group. `meeting_security`: Use this query parameter to view meeting security settings applied on the group.
PATCH
/groups/{groupId}/settings
Update a group's settings
groupId(path, required) — Id of the group.
option(query)
DELETE
/groups/{groupId}/settings/virtual_backgrounds
Delete virtual background files
groupId(path, required) — Unique identifier of the group. Retrieve the value for this field by calling the [List groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.
file_ids(query) — Provide the id of the file that is to be deleted. To delete multiple files, provide comma separated values for this field.
POST
/groups/{groupId}/settings/virtual_backgrounds
Upload virtual background files
groupId(path, required) — Unique identifier of the group. Retrieve the value for this field by calling the [List groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.
GET
/h323/devices
List H.323/SIP devices
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
next_page_token(query) — 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.
GET
/im/chat/sessions/{sessionId}
Get IM chat messages
sessionId(path, required) — IM chat session ID.
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
GET
/im/groups
List IM directory groups
POST
/im/groups
Create an IM directory group
DELETE
/im/groups/{groupId}
Delete an IM directory group
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
GET
/im/groups/{groupId}
Retrieve an IM directory group
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
PATCH
/im/groups/{groupId}
Update an IM directory group
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
GET
/im/groups/{groupId}/members
List IM directory group members
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
next_page_token(query) — 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.
POST
/im/groups/{groupId}/members
Add IM directory group members
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
DELETE
/im/groups/{groupId}/members/{memberId}
Delete an IM directory group member
groupId(path, required) — The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
memberId(path, required) — The member ID.
POST
/im/users/me/chat/messages
Send IM messages
chat_user(query) — The email address (registered with Zoom) or the userId of the chat user.
GET
/im/users/{userId}/chat/messages
Get user’s IM messages
userId(path, required) — The user ID or email address.
chat_user(query) — Chat user's ID or email address.
channel(query) — IM Channel's ID.
date(query) — IM message's query date time, format as yyyy-MM-dd.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
PATCH
/live_meetings/{meetingId}/events
Use in-Meeting recording controls
meetingId(path, required) — Unique identifier of the live meeting.
GET
/meetings/{meetingId}
Get a meeting
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
occurrence_id(query) — Meeting Occurrence ID. Provide this field to view meeting details of a particular occurrence of the [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings).
show_previous_occurrences(query) — Set the value of this field to `true` if you would like to view meeting details of all previous occurrences of a [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings).
PATCH
/meetings/{meetingId}
Update a meeting
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
occurrence_id(query) — Meeting occurrence id. Support change of agenda, start_time, duration, settings: {host_video, participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording}
POST
/meetings/{meetingId}/batch_polls
Perform batch poll creation
meetingId(path, required)
GET
/meetings/{meetingId}/invitation
Get meeting invitation
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
GET
/meetings/{meetingId}/livestream
Get live stream details
meetingId(path, required) — Unique identifier of the meeting.
PATCH
/meetings/{meetingId}/livestream
Update a live stream
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
PATCH
/meetings/{meetingId}/livestream/status
Update Live Stream Status
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
GET
/meetings/{meetingId}/polls
List meeting polls
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
POST
/meetings/{meetingId}/polls
Create a meeting poll
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
GET
/meetings/{meetingId}/recordings
Get meeting recordings
meetingId(path, required) — 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.
include_fields(query) — Get the `download_access_token` field for downloading meeting recordings.
ttl(query) — Time to live (TTL) of the `download_access_token`. This is only valid if the `include_fields` query parameter contains `download_access_token`. The range is between 0-604800.
GET
/meetings/{meetingId}/recordings/registrants
List recording registrants
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
status(query) — The registrant status: `pending` - Registrant's status is pending. `approved` - Registrant's status is approved. `denied` - Registrant's status is denied.
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
next_page_token(query) — 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.
POST
/meetings/{meetingId}/recordings/registrants
Create a recording registrant
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
meetingId(path, required) — 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.
meetingId(path, required) — 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.
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
GET
/meetings/{meetingId}/recordings/settings
Get meeting recording settings
meetingId(path, required) — 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.
DELETE
/meetings/{meetingId}/recordings/{recordingId}
Delete a meeting recording file
meetingId(path, required) — 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.
recordingId(path, required) — The recording ID.
action(query) — The recording delete actions: `trash` - Move recording to trash. `delete` - Delete recording permanently.
meetingId(path, required) — 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.
recordingId(path, required) — The recording ID.
GET
/meetings/{meetingId}/registrants
List meeting registrants
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
occurrence_id(query) — The meeting occurrence ID.
status(query) — The registrant status: `pending` - Registrant's status is pending. `approved` - Registrant's status is approved. `denied` - Registrant's status is denied.
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
next_page_token(query) — 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.
POST
/meetings/{meetingId}/registrants
Add meeting registrant
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
occurrence_ids(query) — Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.
GET
/meetings/{meetingId}/registrants/questions
List registration questions
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
PATCH
/meetings/{meetingId}/registrants/questions
Update registration questions
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
PUT
/meetings/{meetingId}/registrants/status
Update registrant's status
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
occurrence_id(query) — The meeting occurrence ID.
DELETE
/meetings/{meetingId}/registrants/{registrantId}
Delete a meeting registrant
occurrence_id(query) — The meeting occurence ID.
meetingId(path, required) — The meeting ID.
registrantId(path, required) — The meeting registrant ID.
PUT
/meetings/{meetingId}/status
Update meeting status
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
GET
/metrics/im
Get IM metrics
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
GET
/metrics/issues/zoomrooms
Get top 25 Zoom Rooms with issues
from(query, required) — 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.
to(query, required) — End date.
GET
/metrics/issues/zoomrooms/{zoomroomId}
Get issues of Zoom Rooms
zoomroomId(path, required) — The Zoom room ID.
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
GET
/metrics/meetings
List meetings
type(query) — Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following: `past` - Meeting that already occurred in the specified date range. `pastOne` - Past meetings that were attended by only one user. `live` - Live meetings. If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
include_fields(query) — Set the value of this field to "tracking_fields" if you would like to include tracking fields of each meeting in the response.
GET
/metrics/meetings/{meetingId}
Get meeting details
meetingId(path, required) — The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
type(query) — The meeting types: `past` - Past meetings. `pastOne` - Past one user meetings. `live` - Live meetings.
GET
/metrics/meetings/{meetingId}/participants
List meeting participants
meetingId(path, required) — The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
type(query) — The meeting types: `past` - Past meetings. `pastOne` - Past one user meetings. `live` - Live meetings.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
include_fields(query) — 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](https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingregistrants). This is not supported for `live` meeting types.
DELETE
/phone/users/{userId}/settings/{settingType}
Remove shared access
userId(path, required) — Unique identifier of the user.
settingType(path, required) — Corresponds to the setting item you wish to remove. Allowed values: `voice_mail`
shared_id(query, required) — Required only for voicemail setting type.
GET
/metrics/meetings/{meetingId}/participants/qos
List meeting participants QoS
meetingId(path, required) — The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
type(query) — The meeting types: `past` - Past meetings. `live` - Live Meetings.
page_size(query, limit) — The number of items returned per page.
next_page_token(query) — 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.
meetingId(path, required) — The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
type(query) — Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following: `past` - Meeting that already occurred in the specified date range. `pastOne` - Past meetings that were attended by only one user. `live` - Live meetings. If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
next_page_token(query) — 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.
page_size(query, limit) — The number of records returned within a single API call.
meetingId(path, required) — The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
type(query) — The meeting types: `past` - Past meetings. `live` - Live Meetings.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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 exceed the current page size. The expiration period for this token is 15 minutes.
meetingId(path, required) — The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
participantId(path, required) — Participant ID.
type(query) — The meeting types: `past` - Past meetings. `live` - Live Meetings.
GET
/metrics/webinars
List webinars
type(query) — The webinar type.
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
GET
/metrics/webinars/{webinarId}
Get webinar details
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
type(query) — The webinar type.
GET
/metrics/webinars/{webinarId}/participants
Get webinar participants
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
type(query) — The webinar type.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
include_fields(query) — 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 [webinar registrant](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarregistrants).
GET
/metrics/webinars/{webinarId}/participants/qos
List webinar participant QoS
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
type(query) — The webinar type.
page_size(query, limit) — The number of items returned per page.
next_page_token(query) — 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.
type(query) — Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following: `past` - Meeting that already occurred in the specified date range. `pastOne` - Past meetings that were attended by only one user. `live` - Live meetings. If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
type(query) — The webinar type.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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 exceed the current page size. The expiration period for this token is 15 minutes.
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
participantId(path, required) — Participant ID.
type(query) — The webinar type.
GET
/metrics/zoomrooms
List Zoom Rooms
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — The page number of the current page in the returned records.
next_page_token(query) — 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.
GET
/metrics/zoomrooms/issues
Get top 25 issues of Zoom Rooms
from(query, required) — 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.
to(query, required) — End date.
GET
/metrics/zoomrooms/{zoomroomId}
Get Zoom Rooms details
zoomroomId(path, required) — The Zoom room ID.
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
GET
/past_meetings/{meetingId}/files
List past meeting's files
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
GET
/past_meetings/{meetingId}/instances
List ended meeting instances
meetingId(path, required) — The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
GET
/past_meetings/{meetingId}/polls
List past meeting's poll results
meetingId(path, required) — The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
GET
/past_meetings/{meetingUUID}
Get past meeting details
meetingUUID(path, required) — The meeting UUID. Each meeting instance will generate its own Meeting UUID (i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). Please double encode your UUID when using it for other API calls if the UUID begins with a '/'or contains '//' in it.
GET
/past_meetings/{meetingUUID}/participants
Get past meeting participants
meetingUUID(path, required) — The meeting UUID. Each meeting instance will generate its own Meeting UUID (i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). Please double encode your UUID when using it for other API calls if the UUID begins with a '/'or contains '//' in it.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
GET
/past_webinars/{WebinarUUID}/absentees
Get webinar absentees
occurrence_id(query) — The meeting occurrence ID.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
WebinarUUID(path, required) — The Webinar UUID. Each Webinar instance will generate its own Webinar UUID (i.e., after a Webinar ends, a new UUID will be generated for the next instance of the Webinar). Please double encode your UUID when using it for API calls if the UUID begins with a '/' or contains '//' in it.
GET
/past_webinars/{webinarId}/files
List past webinar files
webinarId(path, required)
GET
/past_webinars/{webinarId}/instances
List past webinar instances
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
GET
/past_webinars/{webinarId}/participants
List webinar participants
webinarId(path, required) — Unique identifier of the webinar. You can retrieve the value of this field by calling the [list webinars](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinars) API.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
GET
/past_webinars/{webinarId}/polls
List past webinar poll results
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
GET
/past_webinars/{webinarId}/qa
List Q&A of past webinar
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
POST
/phone/auto_receptionists
Add an auto receptionist
PATCH
/phone/auto_receptionists/{autoReceptionistId}
Update auto receptionist details
autoReceptionistId(path, required) — Unique Identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites).
next_page_token(query) — 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.
page_size(query, limit) — The total number of records returned from a single API call.
POST
/phone/blocked_list
Create a blocked list
DELETE
/phone/blocked_list/{blockedListId}
Delete a blocked list
blockedListId(path, required) — Unique Identifier of the blocked list. This can be retrieved from the List Blocked List API.
GET
/phone/blocked_list/{blockedListId}
Get blocked list details
blockedListId(path, required) — Unique Identifier of the blocked list.
PATCH
/phone/blocked_list/{blockedListId}
Update a blocked list
blockedListId(path, required) — Unique Identifier of the blocked list.
POST
/phone/byoc_numbers
Add BYOC phone numbers
GET
/phone/call_logs
Get account's call logs
page_size(query, limit) — The number of records returned within a single API call.
from(query) — Start date from which you would like to get the call logs. The start date should be within past six months. The API only returns data pertaining to a month. Thus, the date range(defined using "from" and "to" fields) for which the call logs are to be returned must not exceed a month.
to(query) — The end date upto which you would like to get the call logs for. The end date should be within past six months.
type(query) — The type of the call logs. The value can be either "all" or "missed".
next_page_token(query) — 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.
path(query) — Filter the API response by [path](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs#h_646b46c6-0623-4ab1-8b8b-ea5b8bcef679) of the call. The value of this field can be one of the following: `voiceMail`, `message`, `forward`, `extension`, `callQueue`, `ivrMenu`, `companyDirectory`, `autoReceptionist`, `contactCenter`, `disconnected`, `commonAreaPhone`, `pstn`, `transfer`, `sharedLines`, `sharedLineGroup`, `tollFreeBilling`, `meetingService`, `parkPickup`, `parkTimeout`, `monitor`, `takeover`, `sipGroup`
time_type(query) — Enables you to sort call logs by start or end time. Choose the sort time value. Values include `startTime` or `endTime`.
site_id(query) — Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.
GET
/phone/call_queues
List call queues
next_page_token(query) — 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.
page_size(query, limit) — The number of records returned from a single API call.
POST
/phone/call_queues
Create a call queue
DELETE
/phone/call_queues/{callQueueId}
Delete a call queue
callQueueId(path, required) — Unique Identifier of the call queue.
GET
/phone/call_queues/{callQueueId}
Get call queue details
callQueueId(path, required) — Unique Identifier of the Call Queue. This can be retrieved from [List Call Queues API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-call-queues/listcallqueues).
PATCH
/phone/call_queues/{callQueueId}
Update call queue details
callQueueId(path, required) — Unique Identifier of the Call Queue.
PUT
/phone/call_queues/{callQueueId}/manager
Change call queue manager
callQueueId(path, required) — Unique Identifier of the Call Queue.
DELETE
/phone/call_queues/{callQueueId}/members
Unassign all members
callQueueId(path, required)
POST
/phone/call_queues/{callQueueId}/members
Add members to a call queue
callQueueId(path, required) — Unique Identifier of the Call Queue.
callQueueId(path, required) — Unique Identifier of the Call Queue from which the member needs to be unassigned.
memberId(path, required) — Unique Identifier of the member who needs to be unassigned.
DELETE
/phone/call_queues/{callQueueId}/phone_numbers
Unassign all phone numbers
callQueueId(path, required) — Unique Identifier of the Call Queue. This can be retrieved from List Call Queues API.
POST
/phone/call_queues/{callQueueId}/phone_numbers
Assign numbers to a call queue
callQueueId(path, required) — Unique Identifier of the Call Queue.
GET
/phone/call_queues/{callQueueId}/recordings
Get call queue recordings
callQueueId(path, required) — Unique Identifier of the Call Queue.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
from(query) — Start date (within a 6 month range).
to(query) — End date (within a 6 month range).
GET
/phone/calling_plans
List calling plans
GET
/phone/common_area_phones
List common area phones
page_size(query, limit) — The total number of records returned from a single API call.
next_page_token(query) — 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.
POST
/phone/common_area_phones
Add a common area phone
DELETE
/phone/common_area_phones/{commonAreaPhoneId}
Delete a common area phone
commonAreaPhoneId(path, required) — Unique Identifier of the common area phone.
GET
/phone/common_area_phones/{commonAreaPhoneId}
Get common area phone details
commonAreaPhoneId(path, required) — Unique Identifier of the Common Area Phone. Use the unique identifier or the Mac address of the common area phone. The Mac address can be hyphenated (00-04-f2-5e-ec-3c) or not hyphenated (0004f25eec3c). You can retrieved this from the [List Common Area Phones API](https://marketplace.zoom.us/docs/api-reference/zoom-api/common-area-phones/listcommonareaphones).
PATCH
/phone/common_area_phones/{commonAreaPhoneId}
Update common area phone
PUT
/phone/company_number
Change main company number
GET
/phone/devices
List devices
type(query, required) — State of the device. The value should be either `assigned` to list devices that have been assigned to user(s) or `unassigned` to list devices that have not yet been assigned to any user in the Zoom account.
next_page_token(query) — 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.
page_size(query, limit) — The number of records returned within a single API call.
POST
/phone/devices
Add a device
DELETE
/phone/devices/{deviceId}
Delete a device
deviceId(path, required) — Unique Identifier of the device.
GET
/phone/devices/{deviceId}
Get device details
deviceId(path, required) — Unique Identifier of the device.
PATCH
/phone/devices/{deviceId}
Update a device
deviceId(path, required) — Unique Identifier of the Device.
GET
/phone/metrics/call_logs
List call logs
from(query) — Start date for the report in `yyyy-mm-dd` format. Specify a 30 day range using the `from` and `to` parameters as the response provides a maximum of a month worth of data per API request.
to(query) — End date for the report in `yyyy-mm-dd` format.
site_id(query) — Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.
quality_type(query) — Filter call logs by voice quality. Zoom uses MOS of 3.5 as a general baseline to categorize calls by call quality. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality. The value of this field can be one of the following: * `good`: Retrieve call logs of the call(s) with good quality of voice. * `bad`: Retrieve call logs of the call(s) with good quality of voice. * `all`: Retrieve all call logs without filtering by voice quality.
page_size(query, limit) — The number of records returned within a single call.
next_page_token(query) — 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.
GET
/phone/metrics/call_logs/{callId}/qos
Get call QoS
callId(path, required) — Unique identifier of the call.
GET
/phone/metrics/call_logs/{call_id}
Get call details from call log
call_id(path, required) — Unique identifier of the phone call. The value of this field can be retrieved from [List Call Logs]() API.
GET
/phone/numbers
List phone numbers
next_page_token(query) — 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.
type(query) — Query response by number assignment. The value can be one of the following: `assigned`: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account. `unassigned`: The number is not assigned to anyone. `all`: Include both assigned and unassigned numbers in the response. `byoc`: Include Bring Your Own Carrier (BYOC) numbers only in the response.
extension_type(query) — The type of assignee to whom the number is assigned. The value can be one of the following: `user` `callQueue` `autoReceptionist` `commonAreaPhone`
page_size(query, limit) — The number of records returned within a single API call.
number_type(query) — The type of phone number. The value can be either `toll` or `tollfree`.
pending_numbers(query) — Include or exclude pending numbers in the response. The value can be either `true` or `false`.
site_id(query) — Unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) or [Adding a site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15) for details.
GET
/phone/numbers/{numberId}
Get phone number details
numberId(path, required) — Unique Identifier of the Phone Number. This can be retrieved from the List Phone Numbers API.
PATCH
/phone/numbers/{numberId}
Update phone number details
numberId(path, required) — Phone number ID.
PATCH
/phone/users/{userId}/settings/{settingType}
Update shared access
settingType(path, required) — Corresponds to the setting item you wish to modify. Allowed values: `voice_mail`
userId(path, required) — Unique identifier of the user.
GET
/phone/recordings
Get call recordings
page_size(query, limit) — The number of records returned within a single API call. The default is **30**, and the maximum is **100**.
next_page_token(query) — The current page number of returned records.
from(query) — Start date and time in **yyyy-mm-dd** format or **yyyy-MM-dd’T’HH:mm:ss’Z’** 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.
to(query) — End date and time in **yyyy-mm-dd** format or **yyyy-MM-dd’T’HH:mm:ss’Z’** format, the same formats supported by the `from` parameter.
owner_type(query) — The owner type. The allowed values are null, `user`, or `callQueue`. The default is null. If null, returns all owner types.
recording_type(query) — The recording type. The allowed values are null, `OnDemand`, or `Automatic`. The default is null. If null, returns all recording types.
site_id(query) — The site ID. The default is `All sites`.
GET
/phone/reports/operationlogs
Get operation logs report
from(query) — 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 provides only one month worth of data per API request.
to(query) — End date in 'yyyy-mm-dd' format.
category_type(query) — Filter the response by the category of the action performed. By default, the value of this field is "all" and thus, the response will include log of all operations for the defined period. To only include response for a specific category type, provide a value for `category_type` from this [table](http://marketplace.zoom.us/docs/phone-operation-categories ).
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
GET
/phone/setting_templates
List setting templates
page_size(query, limit) — Number of records returns within a single API call.
next_page_token(query) — 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.
site_id(query) — Unique identifier of the site. This field is required only if multiple sites have been enabled. of the site. Required only when multiple sites are enabled. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) for details. If this is not provided, the response lists the account level setting templates.
POST
/phone/setting_templates
Add a setting template
GET
/phone/setting_templates/{templateId}
Get setting template details
templateId(path, required) — Unique identifier of the template.
custom_query_fields(query) — Provide the name of the field to use to filter the response. For example, if you provide "description" as the value of the field, you will get a response similar to the following: {“description”: “template description”}.
PATCH
/phone/setting_templates/{templateId}
Update a setting template
templateId(path, required) — The Template ID.
POST
/phone/users/{userId}/settings/{settingType}
Set up shared access
userId(path, required) — Unique identifier of the user.
settingType(path, required) — Corresponds to the setting item you wish to modify. Allowed values: `voice_mail`
GET
/phone/shared_line_groups
List shared line groups
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
POST
/phone/shared_line_groups
Create a shared line group
DELETE
/phone/shared_line_groups/{sharedLineGroupId}
Delete a shared line group
sharedLineGroupId(path, required) — Unique Identifier of the shared line group that you would like to delete.
GET
/phone/shared_line_groups/{sharedLineGroupId}
Get a shared line group
sharedLineGroupId(path, required) — Unique Identifier of the Shared Line Group.
PATCH
/phone/shared_line_groups/{sharedLineGroupId}
Update a shared line group
sharedLineGroupId(path, required) — Unique identifier of the shared line group that is to be updated.
sharedLineGroupId(path, required) — Unique identifier of the shared line group from which you would like to unassign a phone number.
phoneNumberId(path, required) — Unique identifier of the phone number which is to be unassigned. This can be retrieved from Get a Shared Line Group API.
GET
/phone/sip_trunk/trunks
List BYOC SIP trunks
next_page_token(query) — 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.
page_size(query, limit) — The number of records returned within a single API call.
GET
/phone/sites
List phone sites
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
POST
/phone/sites
Create a phone site
DELETE
/phone/sites/{siteId}
Delete a phone site
siteId(path, required) — Unique Identifier of the Site.
transfer_site_id(query, required) — The Site ID of another site where the assets of the current site (users, numbers and phones) can be transferred to.
GET
/phone/users
List phone users
page_size(query, limit) — The number of records returned from a single API call.
next_page_token(query) — 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.
site_id(query) — Unique Identifier of the site. This can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites) API.
GET
/phone/users/{userId}
Get user's profile
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
PATCH
/phone/users/{userId}
Update user's profile
GET
/phone/users/{userId}/call_logs
Get user's call logs
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
page_size(query, limit) — The number of records returned within a single API call.
from(query, required) — 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.
to(query, required) — End date.
type(query)
next_page_token(query) — 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.
phone_number(query) — Filter API responses to include call logs of only the phone number defined in this field.
time_type(query) — Enables you to sort call logs by start or end time. Choose the sort time value. Values include `startTime` or `endTime`.
DELETE
/phone/users/{userId}/call_logs/{callLogId}
Delete a user's call log
userId(path, required) — The user ID or email address of the user.
callLogId(path, required) — Unique identifier of the call log. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone/accountcalllogs) or [user's call logs](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone/phoneusercalllogs).
POST
/phone/users/{userId}/calling_plans
Assign calling plan to a user
DELETE
/phone/users/{userId}/calling_plans/{type}
Unassign user's calling plan
type(path, required) — The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of the calling plan that was assigned to user. (e.g: The value of type would be "200" for Unlimited US/Canada calling plan.)
userId(path, required) — Provide either userId or email address of the user.
phoneNumberId(path, required) — Provide either phone number or phoneNumberId of the user.
GET
/phone/users/{userId}/recordings
Get user's recordings
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
from(query) — Start date for the query in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the response includes only one month worth of recording data. The month defined should fall within the last six months.
to(query, required) — End date.
GET
/phone/users/{userId}/settings
Get user's settings
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
GET
/phone/users/{userId}/voice_mails
Get user's voicemails
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
page_size(query, limit) — The number of records returned within a single API call.
status(query) — Status of the voice mail
next_page_token(query) — 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.
from(query) — Start date for the query in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the response includes only one month worth of voicemail data. The month defined should fall within the last six months.
to(query, required) — End date.
DELETE
/phone/voice_mails/{voicemailId}
Delete a voicemail
voicemailId(path, required) — Unique identifier of the voicemail. Retrieve the value for this field by calling the [Get voicemails](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone/phoneuservoicemails) API.
GET
/report/activities
Get sign In / sign out activity report
from(query) — 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.
to(query) — End date up to which you would like to view the activity logs report.
page_size(query, limit) — The number of records to be returned within a single API call
next_page_token(query) — Next page token is used to paginate through large result sets
GET
/report/cloud_recording
Get cloud recording usage report
from(query, required) — 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.
to(query, required) — End date.
GET
/report/daily
Get daily usage report
year(query) — Year for this report
month(query) — Month for this report
GET
/report/meetings/{meetingId}
Get meeting detail reports
meetingId(path, required) — The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
GET
/report/users/{userId}/meetings
Get meeting reports
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
type(query) — The meeting types: `past` - Past meetings. `pastOne` - Past one user meetings.
GET
/report/meetings/{meetingId}/participants
Get meeting participant reports
meetingId(path, required) — The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
include_fields(query) — 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](https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingregistrants).
GET
/report/meetings/{meetingId}/polls
Get meeting poll reports
meetingId(path, required) — The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
GET
/report/operationlogs
Get operation logs report
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
category_type(query) — **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`
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
next_page_token(query) — 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.
GET
/report/users
Get active/inactive host reports
type(query) — Active or inactive hosts. `active` - Active hosts. `inactive` - Inactive hosts.
from(query, required) — 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.
to(query, required) — End date.
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — The page number of the current page in the returned records.
next_page_token(query) — 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.
GET
/report/webinars/{webinarId}
Get webinar detail reports
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
GET
/report/webinars/{webinarId}/participants
Get webinar participant reports
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
include_fields(query) — Enter 'registrant_id' as the value for this field if you would like to see the registrant ID attribute included in the response of this API call. A registrant ID is a unique identifier of a [webinar registrant](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarregistrants).
GET
/report/webinars/{webinarId}/polls
Get webinar poll reports
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
GET
/report/webinars/{webinarId}/qa
Get webinar Q&A report
webinarId(path, required) — The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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.
GET
/roles
List roles
POST
/roles
Create a role
DELETE
/roles/{roleId}
Delete a role
roleId(path, required) — Role Id.
GET
/roles/{roleId}
Get role information
roleId(path, required) — Role Id.
PATCH
/roles/{roleId}
Update role information
roleId(path, required) — Role Id
GET
/roles/{roleId}/members
List members in a role
roleId(path, required) — The role ID
page_count(query) — The number of pages returned for this request.
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
next_page_token(query) — 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.
page_size(query, limit) — The number of records returned within a single API call.
POST
/roles/{roleId}/members
Assign a role
roleId(path, required) — The role ID
DELETE
/roles/{roleId}/members/{memberId}
Unassign a role
roleId(path, required) — The role ID
memberId(path, required) — Member's ID
GET
/rooms
List Zoom Rooms
status(query) — The status of the Zoom Room.
type(query) — Type of the Zoom Rooms.
unassigned_rooms(query) — Use this query parameter with a value of `true` if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
location_id(query) — Parent location ID of the Zoom Room.
POST
/rooms
Add a Zoom Room
GET
/rooms/account_profile
Get Zoom Room account profile
PATCH
/rooms/account_profile
Update Zoom Room account profile
GET
/rooms/account_settings
Get Zoom Room account settings
setting_type(query, required) — The type of setting that you would like to retrieve. `alert`: Alert Settings applied on the Zoom Rooms Account. `meeting`: Meeting settings of the Zoom Rooms Account. `signage`: View digital signage settings of the Zoom Rooms Account.
PATCH
/rooms/account_settings
Update Zoom Room account settings
setting_type(query, required) — The type of setting that you would like to update. `alert`: Alert Settings applied on the Zoom Rooms Account. `meeting`: Meeting settings of the Zoom Rooms Account. `signage`: View digital signage settings of the Zoom Rooms Account.
GET
/rooms/digital_signage
List digital signage contents
type(query) — Specify the type of digital signane resource. The value can be one of the following: * `content`: Returns information about content files. * `folder`: Returns information about the folder where the content files are located.
folder_id(query) — Unique identifier of the folder where the content is located. Provide this field if you would like to filter the response by contents that are only available in a specific folder.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
PATCH
/rooms/events
Update E911 digital signage
GET
/rooms/locations
List Zoom Room locations
parent_location_id(query) — A unique identifier of the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level.
type(query) — Use this field to filter the response by the type of location. The value can be one of the following: `country`, `states`, `city`, `campus`, `building`, `floor`.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
POST
/rooms/locations
Add a location
GET
/rooms/locations/structure
Get Zoom Room location structure
PATCH
/rooms/locations/structure
Update Zoom Rooms location structure
GET
/rooms/locations/{locationId}/settings
Get location settings
setting_type(query, required) — The type of setting that you would like to retrieve. `alert`: Alert Settings applied on the Zoom Rooms Account. `meeting`: Meeting settings of the Zoom Rooms Account. `signage`: Digital signage settings of the Zoom Rooms Account.
locationId(path, required) — Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).
PATCH
/rooms/locations/{locationId}/settings
Update location settings
setting_type(query, required) — The type of setting that you would like to update. `alert`: Alert Settings applied on the Zoom Rooms Account. `meeting`: Meeting settings of the Zoom Rooms Account. `signage`: Digital signage settings.
locationId(path, required) — Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).
PATCH
/rooms/{id}/events
Check-in or check-out of a Zoom Room
id(path, required) — Room ID
DELETE
/rooms/{roomId}
Delete a Zoom Room
roomId(path, required) — Unique Identifier of a Zoom Room.
GET
/rooms/{roomId}
Get Zoom Room profile
roomId(path, required) — Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API.
PATCH
/rooms/{roomId}
Update a Zoom Room profile
roomId(path, required) — Unique Identifier of a Zoom Room.
GET
/rooms/{roomId}/devices
List Zoom Room devices
roomId(path, required) — Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API.
PUT
/rooms/{roomId}/devices/{deviceId}/app_version
Change Zoom Rooms' app version
roomId(path, required) — Unique Identifier of the Zoom Room.
deviceId(path, required) — Unique Identifier of the Mac or the Windows device. The value of this field can be retrieved from the [List Zoom Room Devices API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzrdevices).
PUT
/rooms/{roomId}/location
Change a Zoom Room's location
roomId(path, required) — Unique Identifier of the Zoom Room.
GET
/rooms/{roomId}/settings
Get Zoom Room settings
setting_type(query, required) — The type of setting that you would like to retrieve. `alert`: Alert Settings applied on the Zoom Rooms Account. `meeting`: Meeting settings of the Zoom Rooms Account.
roomId(path, required) — Unique identifier of the Zoom Room.
PATCH
/rooms/{roomId}/settings
Update Zoom Room settings
roomId(path, required) — Unique Identifier of the Zoom Room.
setting_type(query) — The type of setting that you would like to update. `alert`: Alert Settings applied on the Zoom Room. `meeting`: Meeting settings of the Zoom Room. `signage`: Digital signage settings applied on the Zoom Room.
GET
/webinars/{webinarId}/polls
List a webinar's polls
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
GET
/sip_phones
List SIP phones
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
search_key(query) — 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.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
POST
/sip_phones
Enable SIP phone
DELETE
/sip_phones/{phoneId}
Delete SIP phone
phoneId(path, required) — Unique Identifier of the SIP Phone. It can be retrieved from the List SIP Phones API.
PATCH
/sip_phones/{phoneId}
Update SIP phone
phoneId(path, required) — Unique Identifier of the SIP Phone. This can be retrieved from the List SIP Phones API.
GET
/sip_trunk/numbers
List SIP trunk numbers
GET
/tracking_fields
List tracking fields
POST
/tracking_fields
Create a tracking field
DELETE
/tracking_fields/{fieldId}
Delete a tracking field
fieldId(path, required) — The Tracking Field ID
GET
/tracking_fields/{fieldId}
Get a tracking field
fieldId(path, required) — The Tracking Field ID
PATCH
/tracking_fields/{fieldId}
Update a tracking field
fieldId(path, required) — The Tracking Field ID
GET
/tsp
Get account's TSP information
PATCH
/tsp
Update account's TSP information
GET
/users
List users
status(query) — User statuses: `active` - Users with an active status. `inactive` - Users who are deactivated. `pending` - Users with a pending status.
page_size(query, limit) — The number of records returned within a single API call.
role_id(query) — Unique identifier of the role. Provide this parameter if you would like to filter the response by a specific role. You can retrieve Role IDs from [List Roles](https://marketplace.zoom.us/docs/api-reference/zoom-api/roles/roles) API.
page_number(query, page) — The page number of the current page in the returned records.
include_fields(query) — Provide a value for this field if you would like to see the following attribute in the response of this API call: `custom_attributes`: Returns custom attributes that are associated with the user. `host_key`: Returns [host key](https://support.zoom.us/hc/en-us/articles/205172555-Using-your-host-key) of the user.
next_page_token(query) — 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.
POST
/users
Create users
GET
/users/email
Check a user email
email(query, required) — The email address to be verified.
GET
/users/me/zak
Get user's ZAK
GET
/users/vanity_name
Check a user's PM room
vanity_name(query, required) — Personal meeting room name.
DELETE
/users/{userId}
Delete a user
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
action(query) — Delete action options: `disassociate` - Disassociate a user. `delete`- Permanently delete a user. Note: To delete pending user in the account, use `disassociate`
transfer_email(query) — Transfer email.
transfer_meeting(query) — Transfer meeting.
transfer_webinar(query) — Transfer webinar.
transfer_recording(query) — Transfer recording.
GET
/users/{userId}
Get a user
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
GET
/users/{userId}/assistants
List user assistants
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
POST
/users/{userId}/assistants
Add assistants
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
DELETE
/users/{userId}/assistants/{assistantId}
Delete a user assistant
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
assistantId(path, required) — Assistant ID.
PUT
/users/{userId}/email
Update a user's email
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
GET
/users/{userId}/meeting_templates
List meeting templates
userId(path, required) — Unique identifier of the user. Retrieve the value of this field by calling the [List users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/users) API.
GET
/users/{userId}/meetings
List meetings
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
type(query) — The meeting types: `scheduled` - This includes all valid past meetings (unexpired), live meetings and upcoming scheduled meetings. It is equivalent to the combined list of "Previous Meetings" and "Upcoming Meetings" displayed in the user's [Meetings page](https://zoom.us/meeting) on the Zoom Web Portal. `live` - All the ongoing meetings. `upcoming` - All upcoming meetings including live meetings.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
page_number(query, page) — The page number of the current page in the returned records.
POST
/webinars/{webinarId}/polls
Create a webinar's poll
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
POST
/users/{userId}/meetings
Create a meeting
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
GET
/users/{userId}/pac
List a user's PAC accounts
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
PUT
/users/{userId}/password
Update a user's password
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
GET
/users/{userId}/permissions
Get user permissions
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
POST
/users/{userId}/picture
Upload a user's profile picture
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
PUT
/users/{userId}/presence_status
Update a user's presence status
GET
/users/{userId}/recordings
List all recordings
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
page_size(query, limit) — The number of records returned within a single API call.
next_page_token(query) — 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.
mc(query) — Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting.
trash(query) — 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.
from(query) — The start date in 'yyyy-mm-dd' UTC format for the date range for which 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.
to(query) — End date in 'yyyy-mm-dd' 'yyyy-mm-dd' UTC format.
trash_type(query) — The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following: `meeting_recordings`: List all meeting recordings from the trash. `recording_file`: List all individual recording files from the trash.
DELETE
/users/{userId}/schedulers
Delete user schedulers
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
GET
/users/{userId}/schedulers
List user schedulers
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
DELETE
/users/{userId}/schedulers/{schedulerId}
Delete a scheduler
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
schedulerId(path, required) — Scheduler's ID.
DELETE
/webinars/{webinarId}/polls/{pollId}
Delete a webinar poll
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
pollId(path, required) — The poll ID
GET
/users/{userId}/settings
Get user settings
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
option(query) — `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the user's account. `recording_authentication`: Use this query parameter to view [recording authentication configuration](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the user's account. `meeting_security`: Use this query parameter to view meeting security settings applied on the user's account.
custom_query_fields(query) — Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following: { "schedule_meeting": { "host_video": false } } You can provide multiple values by separating them with commas(example: "host_video,participant_video”).
PATCH
/users/{userId}/settings
Update user settings
option(query)
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
DELETE
/users/{userId}/settings/virtual_backgrounds
Delete virtual background files
file_ids(query) — Provide the id of the file that is to be deleted. To delete multiple files, provide comma separated values for this field.
userId(path, required) — Unique identifier of the user. Retrieve the value of this field by calling the [List users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/users) API.
POST
/users/{userId}/settings/virtual_backgrounds
Upload virtual background files
userId(path, required) — Unique identifier of the user. Retrieve the value for this field by calling the [List users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/users) API.
PUT
/users/{userId}/status
Update user status
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
DELETE
/users/{userId}/token
Revoke a user's SSO token
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
GET
/users/{userId}/token
Get a user token
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
type(query) — User token types: `token` - Used for starting meetings with the client SDK. This token expires in 14 days and a new token will be returned after the expiry. `zak` - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.
ttl(query) — Use this field in conjunction with the `type` field where the value of `type` field is `zak`. The value of this field denotes the expiry time of the `zak` token in seconds. For example, if you would like the zak token to be expired after one hour of the token generation, the value of this field should be `3600`.
GET
/users/{userId}/tsp
List user's TSP accounts
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
POST
/users/{userId}/tsp
Add a user's TSP account
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
PATCH
/users/{userId}/tsp/settings
Set global dial-in URL for a TSP user
userId(path, required) — The userId or email address of the user.
DELETE
/users/{userId}/tsp/{tspId}
Delete a user's TSP account
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
tspId(path, required) — TSP account ID.
GET
/users/{userId}/tsp/{tspId}
Get a user's TSP account
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
tspId(path, required) — TSP account ID.
PATCH
/users/{userId}/tsp/{tspId}
Update a TSP account
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
tspId(path, required) — TSP account ID.
GET
/users/{userId}/webinar_templates
List webinar templates
GET
/users/{userId}/webinars
List webinars
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
POST
/users/{userId}/webinars
Create a webinar
userId(path, required) — The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
DELETE
/webinars/{webinarId}
Delete a webinar
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
occurrence_id(query) — The meeting occurrence ID.
cancel_webinar_reminder(query) — `true`: Notify panelists and registrants about the webinar cancellation via email. `false`: Do not send any email notification to webinar registrants and panelists. The default value of this field is `false`.
GET
/webinars/{webinarId}
Get a webinar
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
occurrence_id(query) — Unique Identifier that identifies 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 API](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate), you can retrieve the Occurrence ID from the response of the API call.
show_previous_occurrences(query) — Set the value of this field to `true` if you would like to view Webinar details of all previous occurrences of a recurring Webinar.
PATCH
/webinars/{webinarId}
Update a webinar
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
occurrence_id(query) — Webinar occurrence id. Support change of agenda, start_time, duration, settings: {host_video, panelist_video, hd_video, watermark, auto_recording}
POST
/webinars/{webinarId}/batch_registrants
Perform batch registration
webinarId(path, required) — Unique identifier of the webinar.
DELETE
/webinars/{webinarId}/panelists
Remove panelists
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
GET
/webinars/{webinarId}/panelists
List panelists
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
GET
/webinars/{webinarId}/registrants
List webinar registrants
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
occurrence_id(query) — The meeting occurrence ID.
status(query) — The registrant status: `pending` - Registrant's status is pending. `approved` - Registrant's status is approved. `denied` - Registrant's status is denied.
tracking_source_id(query) — 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](https://support.zoom.us/hc/en-us/articles/360000315683-Creating-source-tracking-links-for-webinar-registration) for details.
page_size(query, limit) — The number of records returned within a single API call.
page_number(query, page) — **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. The page number of the current page in the returned records.
next_page_token(query) — 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.
POST
/webinars/{webinarId}/registrants
Add a webinar registrant
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
occurrence_ids(query) — Occurrence ID. Get this value from the webinar get API. Multiple values separated by a comma.
GET
/webinars/{webinarId}/registrants/questions
List registration questions
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
PATCH
/webinars/{webinarId}/registrants/questions
Update registration questions
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
PUT
/webinars/{webinarId}/registrants/status
Update registrant's status
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
occurrence_id(query) — The meeting occurrence ID.
DELETE
/webinars/{webinarId}/registrants/{registrantId}
Delete a webinar registrant
webinarId(path, required) — The webinar ID.
registrantId(path, required) — The registrant ID.
occurrence_id(query) — The webinar occurence ID.
GET
/webinars/{webinarId}/registrants/{registrantId}
Get a webinar registrant
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
registrantId(path, required) — The registrant ID.
occurrence_id(query) — The meeting occurrence ID.
PUT
/webinars/{webinarId}/status
Update webinar status
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
GET
/webinars/{webinarId}/tracking_sources
Get webinar tracking sources
webinarId(path, required) — The webinar ID in "**long**" format(represented as int64 data type in JSON).
373 endpoints auto-detected
Authentication
This API uses an API key, passed in the "Authorization" header. No OAuth required.
