# @bunchtogether/zoom-api-v2 > [![npm version](https://badge.fury.io/js/%40bunchtogether%2Fzoom-api-v2.svg)](http://badge.fury.io/js/%40bunchtogether%2Fzoom-api-v2) Latest version **1.0.5** (published 2019-06-29) · MIT license · 0 weekly downloads ## Install ```sh npm install @bunchtogether/zoom-api-v2 pnpm add @bunchtogether/zoom-api-v2 yarn add @bunchtogether/zoom-api-v2 bun add @bunchtogether/zoom-api-v2 ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.5 | | Published | 2019-06-29 | | First published | 2019-06-28 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 2.6 MB | | Known vulnerabilities | 0 (+3 in 1 direct dependencies) | | Install scripts | no | | Author | John Wehr | | Maintainers | bunchtogether | ## Links - npm: https://www.npmjs.com/package/@bunchtogether/zoom-api-v2 - Repository: https://github.com/bunchtogether/zoom-api-v2 - Homepage: https://github.com/bunchtogether/zoom-api-v2#readme - Issues: https://github.com/bunchtogether/zoom-api-v2/issues - npm.io page: https://npm.io/package/@bunchtogether/zoom-api-v2 ## Dependencies (2) - [superagent](https://npm.io/package/superagent.md) ^5.1.0 - [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^8.5.1 ## Recent versions - 1.0.5 (latest) — 2019-06-29 - 1.0.3 — 2019-06-28 - 1.0.2 — 2019-06-28 - 1.0.1 — 2019-06-28 - 1.0.0 — 2019-06-28 ## README # Unofficial Zoom API (v2) Client [![npm version](https://badge.fury.io/js/%40bunchtogether%2Fzoom-api-v2.svg)](http://badge.fury.io/js/%40bunchtogether%2Fzoom-api-v2) Unofficial Zoom [REST API](https://marketplace.zoom.us/docs/api-reference/introduction) client generated from the [Zoom API (v2) Swagger definition](https://marketplace.zoom.us/docs/api-reference/zoom-api/Zoom%20API.oas2.json) using [swagger-typescript-codegen](https://www.npmjs.com/package/swagger-typescript-codegen) and subsequent modifications. ZOOM is a trademark of Zoom Video Communications, Inc. All content on this page derived from the [Zoom API (v2) Swagger definition](https://marketplace.zoom.us/docs/api-reference/zoom-api/Zoom%20API.oas2.json) copyright Zoom Video Communications, Inc. ## Install `yarn add @bunchtogether/zoom-api-v2` ## Usage ```js import Zoom from 'zoom-api-v2'; const API_KEY = "YOUR API KEY HERE"; const API_SECRET = "YOUR API SECRET HERE"; const zoom = new Zoom(API_KEY, API_SECRET); const run = async () => { const users = await zoom.users({}); console.log(JSON.stringify(users.body, null, 2)); } run(); /* Logs: { "page_count": 1, "page_number": 1, "page_size": 30, "total_records": 1, "users": [ { "id": "XXX", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com", "type": 2, "pmi": 123456789, "timezone": "America/New_York", "verified": 1, "dept": "", "created_at": "2018-07-18T14:48:45Z", "last_login_time": "2019-06-27T14:59:25Z", "last_client_version": "4.3.46560.0311(win)", "pic_url": "XXX", "status": "active" } ] } */ ``` ## API #### Table of Contents - [Zoom](#zoom) - [Parameters](#parameters) - [Zoom#accounts](#zoomaccounts) - [Parameters](#parameters-1) - [Zoom#accountCreate](#zoomaccountcreate) - [Zoom#account](#zoomaccount) - [Parameters](#parameters-2) - [Zoom#accountDisassociate](#zoomaccountdisassociate) - [Parameters](#parameters-3) - [Zoom#accountOptionsUpdate](#zoomaccountoptionsupdate) - [Parameters](#parameters-4) - [Zoom#accountSettings](#zoomaccountsettings) - [Parameters](#parameters-5) - [Zoom#accountSettingsUpdate](#zoomaccountsettingsupdate) - [Parameters](#parameters-6) - [Zoom#accountManagedDomain](#zoomaccountmanageddomain) - [Parameters](#parameters-7) - [Zoom#accountTrustedDomain](#zoomaccounttrusteddomain) - [Parameters](#parameters-8) - [Zoom#accountBilling](#zoomaccountbilling) - [Parameters](#parameters-9) - [Zoom#accountBillingUpdate](#zoomaccountbillingupdate) - [Parameters](#parameters-10) - [Zoom#accountPlans](#zoomaccountplans) - [Parameters](#parameters-11) - [Zoom#accountPlanCreate](#zoomaccountplancreate) - [Parameters](#parameters-12) - [Zoom#accountPlanBaseUpdate](#zoomaccountplanbaseupdate) - [Parameters](#parameters-13) - [Zoom#accountPlanAddonCreate](#zoomaccountplanaddoncreate) - [Parameters](#parameters-14) - [Zoom#accountPlanAddonUpdate](#zoomaccountplanaddonupdate) - [Parameters](#parameters-15) - [Zoom#groups](#zoomgroups) - [Zoom#groupCreate](#zoomgroupcreate) - [Zoom#group](#zoomgroup) - [Parameters](#parameters-16) - [Zoom#groupUpdate](#zoomgroupupdate) - [Parameters](#parameters-17) - [Zoom#groupDelete](#zoomgroupdelete) - [Parameters](#parameters-18) - [Zoom#groupMembers](#zoomgroupmembers) - [Parameters](#parameters-19) - [Zoom#groupMembersCreate](#zoomgroupmemberscreate) - [Parameters](#parameters-20) - [Zoom#groupMembersDelete](#zoomgroupmembersdelete) - [Parameters](#parameters-21) - [Zoom#deviceList](#zoomdevicelist) - [Zoom#deviceCreate](#zoomdevicecreate) - [Zoom#deviceUpdate](#zoomdeviceupdate) - [Parameters](#parameters-22) - [Zoom#deviceDelete](#zoomdevicedelete) - [Parameters](#parameters-23) - [Zoom#trackingfieldList](#zoomtrackingfieldlist) - [Zoom#trackingfieldCreate](#zoomtrackingfieldcreate) - [Zoom#trackingfieldGet](#zoomtrackingfieldget) - [Parameters](#parameters-24) - [Zoom#trackingfieldUpdate](#zoomtrackingfieldupdate) - [Parameters](#parameters-25) - [Zoom#trackingfieldDelete](#zoomtrackingfielddelete) - [Parameters](#parameters-26) - [Zoom#imGroups](#zoomimgroups) - [Zoom#imGroupCreate](#zoomimgroupcreate) - [Zoom#imGroup](#zoomimgroup) - [Parameters](#parameters-27) - [Zoom#imGroupUpdate](#zoomimgroupupdate) - [Parameters](#parameters-28) - [Zoom#imGroupDelete](#zoomimgroupdelete) - [Parameters](#parameters-29) - [Zoom#imGroupMembers](#zoomimgroupmembers) - [Parameters](#parameters-30) - [Zoom#imGroupMembersCreate](#zoomimgroupmemberscreate) - [Parameters](#parameters-31) - [Zoom#imGroupMembersDelete](#zoomimgroupmembersdelete) - [Parameters](#parameters-32) - [Zoom#imChatSessions](#zoomimchatsessions) - [Parameters](#parameters-33) - [Zoom#imChatMessages](#zoomimchatmessages) - [Parameters](#parameters-34) - [Zoom#meetings](#zoommeetings) - [Parameters](#parameters-35) - [Zoom#meetingCreate](#zoommeetingcreate) - [Parameters](#parameters-36) - [Zoom#meeting](#zoommeeting) - [Parameters](#parameters-37) - [Zoom#meetingUpdate](#zoommeetingupdate) - [Parameters](#parameters-38) - [Zoom#meetingDelete](#zoommeetingdelete) - [Parameters](#parameters-39) - [Zoom#meetingStatus](#zoommeetingstatus) - [Parameters](#parameters-40) - [Zoom#meetingRegistrants](#zoommeetingregistrants) - [Parameters](#parameters-41) - [Zoom#meetingRegistrantCreate](#zoommeetingregistrantcreate) - [Parameters](#parameters-42) - [Zoom#meetingRegistrantStatus](#zoommeetingregistrantstatus) - [Parameters](#parameters-43) - [Zoom#pastMeetingDetails](#zoompastmeetingdetails) - [Parameters](#parameters-44) - [Zoom#pastMeetingParticipants](#zoompastmeetingparticipants) - [Parameters](#parameters-45) - [Zoom#pastMeetings](#zoompastmeetings) - [Parameters](#parameters-46) - [Zoom#meetingPolls](#zoommeetingpolls) - [Parameters](#parameters-47) - [Zoom#meetingPollCreate](#zoommeetingpollcreate) - [Parameters](#parameters-48) - [Zoom#meetingPollGet](#zoommeetingpollget) - [Parameters](#parameters-49) - [Zoom#meetingPollUpdate](#zoommeetingpollupdate) - [Parameters](#parameters-50) - [Zoom#meetingPollDelete](#zoommeetingpolldelete) - [Parameters](#parameters-51) - [Zoom#meetingRegistrantsQuestionsGet](#zoommeetingregistrantsquestionsget) - [Parameters](#parameters-52) - [Zoom#meetingRegistrantQuestionUpdate](#zoommeetingregistrantquestionupdate) - [Parameters](#parameters-53) - [Zoom#recordingsList](#zoomrecordingslist) - [Parameters](#parameters-54) - [Zoom#recordingGet](#zoomrecordingget) - [Parameters](#parameters-55) - [Zoom#recordingDelete](#zoomrecordingdelete) - [Parameters](#parameters-56) - [Zoom#recordingDeleteOne](#zoomrecordingdeleteone) - [Parameters](#parameters-57) - [Zoom#recordingStatusUpdate](#zoomrecordingstatusupdate) - [Parameters](#parameters-58) - [Zoom#recordingStatusUpdateOne](#zoomrecordingstatusupdateone) - [Parameters](#parameters-59) - [Zoom#recordingSettingUpdate](#zoomrecordingsettingupdate) - [Parameters](#parameters-60) - [Zoom#recordingSettingsUpdate](#zoomrecordingsettingsupdate) - [Parameters](#parameters-61) - [Zoom#meetingRecordingRegistrants](#zoommeetingrecordingregistrants) - [Parameters](#parameters-62) - [Zoom#meetingRecordingRegistrantCreate](#zoommeetingrecordingregistrantcreate) - [Parameters](#parameters-63) - [Zoom#meetingRecordingRegistrantStatus](#zoommeetingrecordingregistrantstatus) - [Parameters](#parameters-64) - [Zoom#recordingRegistrantsQuestionsGet](#zoomrecordingregistrantsquestionsget) - [Parameters](#parameters-65) - [Zoom#recordingRegistrantQuestionUpdate](#zoomrecordingregistrantquestionupdate) - [Parameters](#parameters-66) - [Zoom#dashboardMeetings](#zoomdashboardmeetings) - [Parameters](#parameters-67) - [Zoom#dashboardMeetingDetail](#zoomdashboardmeetingdetail) - [Parameters](#parameters-68) - [Zoom#dashboardMeetingParticipants](#zoomdashboardmeetingparticipants) - [Parameters](#parameters-69) - [Zoom#dashboardMeetingParticipantQOS](#zoomdashboardmeetingparticipantqos) - [Parameters](#parameters-70) - [Zoom#dashboardMeetingParticipantsQOS](#zoomdashboardmeetingparticipantsqos) - [Parameters](#parameters-71) - [Zoom#dashboardMeetingParticipantShare](#zoomdashboardmeetingparticipantshare) - [Parameters](#parameters-72) - [Zoom#dashboardWebinars](#zoomdashboardwebinars) - [Parameters](#parameters-73) - [Zoom#dashboardWebinarDetail](#zoomdashboardwebinardetail) - [Parameters](#parameters-74) - [Zoom#dashboardWebinarParticipants](#zoomdashboardwebinarparticipants) - [Parameters](#parameters-75) - [Zoom#dashboardWebinarParticipantQOS](#zoomdashboardwebinarparticipantqos) - [Parameters](#parameters-76) - [Zoom#dashboardWebinarParticipantsQOS](#zoomdashboardwebinarparticipantsqos) - [Parameters](#parameters-77) - [Zoom#dashboardWebinarParticipantShare](#zoomdashboardwebinarparticipantshare) - [Parameters](#parameters-78) - [Zoom#dashboardZoomRooms](#zoomdashboardzoomrooms) - [Parameters](#parameters-79) - [Zoom#dashboardZoomRoom](#zoomdashboardzoomroom) - [Parameters](#parameters-80) - [Zoom#dashboardCRC](#zoomdashboardcrc) - [Parameters](#parameters-81) - [Zoom#dashboardIM](#zoomdashboardim) - [Parameters](#parameters-82) - [Zoom#dashboardClientFeedback](#zoomdashboardclientfeedback) - [Parameters](#parameters-83) - [Zoom#dashboardZoomRoomIssue](#zoomdashboardzoomroomissue) - [Parameters](#parameters-84) - [Zoom#dashboardIssueZoomRoom](#zoomdashboardissuezoomroom) - [Parameters](#parameters-85) - [Zoom#dashboardIssueDetailZoomRoom](#zoomdashboardissuedetailzoomroom) - [Parameters](#parameters-86) - [Zoom#reportDaily](#zoomreportdaily) - [Parameters](#parameters-87) - [Zoom#reportUsers](#zoomreportusers) - [Parameters](#parameters-88) - [Zoom#reportMeetings](#zoomreportmeetings) - [Parameters](#parameters-89) - [Zoom#reportMeetingDetails](#zoomreportmeetingdetails) - [Parameters](#parameters-90) - [Zoom#reportMeetingParticipants](#zoomreportmeetingparticipants) - [Parameters](#parameters-91) - [Zoom#reportMeetingPolls](#zoomreportmeetingpolls) - [Parameters](#parameters-92) - [Zoom#reportWebinarDetails](#zoomreportwebinardetails) - [Parameters](#parameters-93) - [Zoom#reportWebinarParticipants](#zoomreportwebinarparticipants) - [Parameters](#parameters-94) - [Zoom#reportWebinarPolls](#zoomreportwebinarpolls) - [Parameters](#parameters-95) - [Zoom#reportWebinarQA](#zoomreportwebinarqa) - [Parameters](#parameters-96) - [Zoom#reportTelephone](#zoomreporttelephone) - [Parameters](#parameters-97) - [Zoom#reportCloudRecording](#zoomreportcloudrecording) - [Parameters](#parameters-98) - [Zoom#reportOperationLogs](#zoomreportoperationlogs) - [Parameters](#parameters-99) - [Zoom#roles](#zoomroles) - [Zoom#createRole](#zoomcreaterole) - [Zoom#roleMembers](#zoomrolemembers) - [Parameters](#parameters-100) - [Zoom#AddRoleMembers](#zoomaddrolemembers) - [Parameters](#parameters-101) - [Zoom#roleMemberDelete](#zoomrolememberdelete) - [Parameters](#parameters-102) - [Zoom#tsp](#zoomtsp) - [Zoom#tspUpdate](#zoomtspupdate) - [Zoom#users](#zoomusers) - [Parameters](#parameters-103) - [Zoom#userCreate](#zoomusercreate) - [Zoom#user](#zoomuser) - [Parameters](#parameters-104) - [Zoom#userUpdate](#zoomuserupdate) - [Parameters](#parameters-105) - [Zoom#userDelete](#zoomuserdelete) - [Parameters](#parameters-106) - [Zoom#userAssistants](#zoomuserassistants) - [Parameters](#parameters-107) - [Zoom#userAssistantCreate](#zoomuserassistantcreate) - [Parameters](#parameters-108) - [Zoom#userAssistantsDelete](#zoomuserassistantsdelete) - [Parameters](#parameters-109) - [Zoom#userAssistantDelete](#zoomuserassistantdelete) - [Parameters](#parameters-110) - [Zoom#userSchedulers](#zoomuserschedulers) - [Parameters](#parameters-111) - [Zoom#userSchedulersDelete](#zoomuserschedulersdelete) - [Parameters](#parameters-112) - [Zoom#userSchedulerDelete](#zoomuserschedulerdelete) - [Parameters](#parameters-113) - [Zoom#userPicture](#zoomuserpicture) - [Parameters](#parameters-114) - [Zoom#userSettings](#zoomusersettings) - [Parameters](#parameters-115) - [Zoom#userSettingsUpdate](#zoomusersettingsupdate) - [Parameters](#parameters-116) - [Zoom#userStatus](#zoomuserstatus) - [Parameters](#parameters-117) - [Zoom#userPassword](#zoomuserpassword) - [Parameters](#parameters-118) - [Zoom#userPermission](#zoomuserpermission) - [Parameters](#parameters-119) - [Zoom#userPACs](#zoomuserpacs) - [Parameters](#parameters-120) - [Zoom#userTSPs](#zoomusertsps) - [Parameters](#parameters-121) - [Zoom#userTSPCreate](#zoomusertspcreate) - [Parameters](#parameters-122) - [Zoom#userTSP](#zoomusertsp) - [Parameters](#parameters-123) - [Zoom#userTSPUpdate](#zoomusertspupdate) - [Parameters](#parameters-124) - [Zoom#userTSPDelete](#zoomusertspdelete) - [Parameters](#parameters-125) - [Zoom#userToken](#zoomusertoken) - [Parameters](#parameters-126) - [Zoom#userSSOTokenDelete](#zoomuserssotokendelete) - [Parameters](#parameters-127) - [Zoom#userEmail](#zoomuseremail) - [Parameters](#parameters-128) - [Zoom#userEmailUpdate](#zoomuseremailupdate) - [Parameters](#parameters-129) - [Zoom#userVanityName](#zoomuservanityname) - [Parameters](#parameters-130) - [Zoom#webinars](#zoomwebinars) - [Parameters](#parameters-131) - [Zoom#webinarCreate](#zoomwebinarcreate) - [Parameters](#parameters-132) - [Zoom#webinar](#zoomwebinar) - [Parameters](#parameters-133) - [Zoom#webinarUpdate](#zoomwebinarupdate) - [Parameters](#parameters-134) - [Zoom#webinarDelete](#zoomwebinardelete) - [Parameters](#parameters-135) - [Zoom#webinarStatus](#zoomwebinarstatus) - [Parameters](#parameters-136) - [Zoom#webinarPanelists](#zoomwebinarpanelists) - [Parameters](#parameters-137) - [Zoom#webinarPanelistCreate](#zoomwebinarpanelistcreate) - [Parameters](#parameters-138) - [Zoom#webinarPanelistsDelete](#zoomwebinarpanelistsdelete) - [Parameters](#parameters-139) - [Zoom#webinarPanelistDelete](#zoomwebinarpanelistdelete) - [Parameters](#parameters-140) - [Zoom#webinarRegistrants](#zoomwebinarregistrants) - [Parameters](#parameters-141) - [Zoom#webinarRegistrantCreate](#zoomwebinarregistrantcreate) - [Parameters](#parameters-142) - [Zoom#webinarRegistrantStatus](#zoomwebinarregistrantstatus) - [Parameters](#parameters-143) - [Zoom#pastWebinars](#zoompastwebinars) - [Parameters](#parameters-144) - [Zoom#webinarPolls](#zoomwebinarpolls) - [Parameters](#parameters-145) - [Zoom#webinarPollCreate](#zoomwebinarpollcreate) - [Parameters](#parameters-146) - [Zoom#webinarPollGet](#zoomwebinarpollget) - [Parameters](#parameters-147) - [Zoom#webinarPollUpdate](#zoomwebinarpollupdate) - [Parameters](#parameters-148) - [Zoom#webinarPollDelete](#zoomwebinarpolldelete) - [Parameters](#parameters-149) - [Zoom#webinarRegistrantsQuestionsGet](#zoomwebinarregistrantsquestionsget) - [Parameters](#parameters-150) - [Zoom#webinarRegistrantQuestionUpdate](#zoomwebinarregistrantquestionupdate) - [Parameters](#parameters-151) - [Zoom#sendchatbot](#zoomsendchatbot) - [Zoom#getchatchannels](#zoomgetchatchannels) - [Parameters](#parameters-152) - [Zoom#meetingInvitation](#zoommeetinginvitation) - [Parameters](#parameters-153) - [Zoom#meetingLiveStreamUpdate](#zoommeetinglivestreamupdate) - [Parameters](#parameters-154) - [Zoom#meetingLiveStreamStatusUpdate](#zoommeetinglivestreamstatusupdate) - [Parameters](#parameters-155) - [Zoom#dashboardClientFeedbackDetail](#zoomdashboardclientfeedbackdetail) - [Parameters](#parameters-156) - [Zoom#listimmessages](#zoomlistimmessages) - [Parameters](#parameters-157) - [Zoom#sendimmessages](#zoomsendimmessages) - [Parameters](#parameters-158) - [Zoom#compliance](#zoomcompliance) - [Zoom#webinarRegistrantGet](#zoomwebinarregistrantget) - [Parameters](#parameters-159) - [Zoom#phoneUser](#zoomphoneuser) - [Parameters](#parameters-160) - [Zoom#updateUserProfile](#zoomupdateuserprofile) - [Parameters](#parameters-161) - [Zoom#phoneUserSettings](#zoomphoneusersettings) - [Parameters](#parameters-162) - [Zoom#phoneUserCallLogs](#zoomphoneusercalllogs) - [Parameters](#parameters-163) - [Zoom#phoneUserRecordings](#zoomphoneuserrecordings) - [Parameters](#parameters-164) - [Zoom#phoneUserVoiceMails](#zoomphoneuservoicemails) - [Parameters](#parameters-165) - [Zoom#webinarAbsentees](#zoomwebinarabsentees) - [Parameters](#parameters-166) - [Zoom#tspUrlUpdate](#zoomtspurlupdate) - [Parameters](#parameters-167) - [Zoom#accountCallLogs](#zoomaccountcalllogs) - [Parameters](#parameters-168) - [Zoom#assignPhoneNumber](#zoomassignphonenumber) - [Parameters](#parameters-169) - [Zoom#UnassignPhoneNumber](#zoomunassignphonenumber) - [Parameters](#parameters-170) - [Zoom#assignCallingPlan](#zoomassigncallingplan) - [Parameters](#parameters-171) - [Zoom#unassignCallingPlan](#zoomunassigncallingplan) - [Parameters](#parameters-172) - [Zoom#retrieveCallStatus](#zoomretrievecallstatus) - [Parameters](#parameters-173) - [Zoom#accountPlanBaseDelete](#zoomaccountplanbasedelete) - [Parameters](#parameters-174) - [Zoom#accountPlanAddonCancel](#zoomaccountplanaddoncancel) - [Parameters](#parameters-175) - [Zoom#reportSignInSignOutActivities](#zoomreportsigninsignoutactivities) - [Parameters](#parameters-176) - [Zoom#getGroupSettings](#zoomgetgroupsettings) - [Parameters](#parameters-177) - [Zoom#updateGroupSettings](#zoomupdategroupsettings) - [Parameters](#parameters-178) - [Zoom#getGroupLockSettings](#zoomgetgrouplocksettings) - [Parameters](#parameters-179) - [Zoom#groupLockedSettings](#zoomgrouplockedsettings) - [Parameters](#parameters-180) - [Zoom#getRoleInformation](#zoomgetroleinformation) - [Parameters](#parameters-181) - [Zoom#updateRole](#zoomupdaterole) - [Parameters](#parameters-182) - [Zoom#deleteRole](#zoomdeleterole) - [Parameters](#parameters-183) - [Zoom#getPlanUsage](#zoomgetplanusage) - [Parameters](#parameters-184) - [Zoom#updateAccountOwner](#zoomupdateaccountowner) - [Parameters](#parameters-185) ### Zoom [src/index.js:2628-21138](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L2628-L21138 "Source code on GitHub") The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`. For instance you can list all users on an account via `https://api.zoom.us/v2/users/`. #### Parameters - `apiKey` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** The API Key. - `apiSecret` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** The API Secreg. - `domainOrOptions` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?** The project domain. ### Zoom#accounts [src/index.js:2784-2819](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L2784-L2819 "Source code on GitHub") List all the sub accounts under the master account. ##### Scopes: - `account:read:admin` #### Parameters - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#accountCreate [src/index.js:2864-2915](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L2864-L2915 "Source code on GitHub") Create a sub account under the master account. ##### Scopes: - `account:write:admin` ### Zoom#account [src/index.js:2947-2980](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L2947-L2980 "Source code on GitHub") Get a sub account under the master account. ##### Scopes: - `account:read:admin` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountDisassociate [src/index.js:3012-3045](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L3012-L3045 "Source code on GitHub") Disassociate a sub account from the master account. This will leave the sub account intact but it will no longer be associated with the master account. ##### Scopes: - `account:write:admin` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountOptionsUpdate [src/index.js:3088-3137](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L3088-L3137 "Source code on GitHub") Update a sub account's options under the master account. ##### Scopes: - `account:write:admin` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountSettings [src/index.js:3169-3202](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L3169-L3202 "Source code on GitHub") Get a sub account's settings under the master account. ##### Scopes: - `account:read:admin` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountSettingsUpdate [src/index.js:3361-3526](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L3361-L3526 "Source code on GitHub") Update a sub account's settings under the master account. ##### Scopes: - `account:read:admin` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountManagedDomain [src/index.js:3558-3591](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L3558-L3591 "Source code on GitHub") Get a sub account's managed domains under the master account. ##### Scopes: - `account:read:admin` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountTrustedDomain [src/index.js:3622-3655](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L3622-L3655 "Source code on GitHub") Get a sub account's trusted domains under the master account #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountBilling [src/index.js:3687-3720](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L3687-L3720 "Source code on GitHub") Get [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) for a sub account under a master account. ##### Scopes: - `billing:master` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountBillingUpdate [src/index.js:3768-3822](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L3768-L3822 "Source code on GitHub") Update [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) for a sub account under a master account. ##### Scopes: - `billing:master` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountPlans [src/index.js:3854-3887](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L3854-L3887 "Source code on GitHub") Get plan information for a sub account under the master account. ##### Scopes: - `billing:master` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountPlanCreate [src/index.js:3969-4058](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L3969-L4058 "Source code on GitHub") Subscribe plans for a sub account of a master account. ##### Scopes: - `billing:master` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountPlanBaseUpdate [src/index.js:4098-4144](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4098-L4144 "Source code on GitHub") Update a base plan for a sub account. ##### Scopes: - `billing:master` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountPlanAddonCreate [src/index.js:4186-4235](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4186-L4235 "Source code on GitHub") Add an additional plan for a sub account. ##### Scopes: - `billing:master` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#accountPlanAddonUpdate [src/index.js:4275-4321](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4275-L4321 "Source code on GitHub") Update an additional plan for a sub account. ##### Scopes: - `billing:master` #### Parameters - `accountId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The account ID. ### Zoom#groups [src/index.js:4350-4374](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4350-L4374 "Source code on GitHub") List [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. ##### Prerequisites: Pro, Business, or Education account ##### Scopes: - `group:read:admin` ### Zoom#groupCreate [src/index.js:4413-4453](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4413-L4453 "Source code on GitHub") Create a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. ##### Prerequisites: Pro, Business, or Education account ##### Scopes: - `group:write:admin` ### Zoom#group [src/index.js:4488-4521](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4488-L4521 "Source code on GitHub") Get a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. ##### Prerequisites: Pro, Business, or Education account ##### Scopes: - `group:read:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). ### Zoom#groupUpdate [src/index.js:4563-4608](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4563-L4608 "Source code on GitHub") Update a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. ##### Prerequisites: Pro, Business, or Education account ##### Scopes: - `group:write:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). ### Zoom#groupDelete [src/index.js:4643-4676](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4643-L4676 "Source code on GitHub") Delete a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. ##### Prerequisites: Pro, Business, or Education account ##### Scopes: - `group:write:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). ### Zoom#groupMembers [src/index.js:4722-4765](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4722-L4765 "Source code on GitHub") List the members of a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. ##### Prerequisites: Pro, Business, or Education account ##### Scopes: - `group:write:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#groupMembersCreate [src/index.js:4813-4865](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4813-L4865 "Source code on GitHub") Add members to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. ##### Prerequisites: Pro, Business, or Education account ##### Scopes: - `group:write:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). ### Zoom#groupMembersDelete [src/index.js:4904-4945](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4904-L4945 "Source code on GitHub") Delete a member from a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. ##### Prerequisites: Pro, Business, or Education account ##### Scopes: - `group:write:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). - `memberId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The member ID. ### Zoom#deviceList [src/index.js:4972-4996](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L4972-L4996 "Source code on GitHub") List H.323/SIP Devices on your Zoom account. ##### Scopes: - `h323:read:admin` ### Zoom#deviceCreate [src/index.js:5033-5076](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5033-L5076 "Source code on GitHub") Create a H.323/SIP Device on your Zoom account ##### Scopes: - `h323:write:admin` ### Zoom#deviceUpdate [src/index.js:5118-5166](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5118-L5166 "Source code on GitHub") Update a H.323/SIP device from your Zoom account. ##### Scopes: - `h323:write:admin` #### Parameters - `deviceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The device ID. ### Zoom#deviceDelete [src/index.js:5198-5231](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5198-L5231 "Source code on GitHub") Delete a H.323/SIP device from your Zoom account. ##### Scopes: - `h323:write:admin` #### Parameters - `deviceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The device ID. ### Zoom#trackingfieldList [src/index.js:5258-5282](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5258-L5282 "Source code on GitHub") List Tracking Fields on your Zoom account. ##### Scopes: - `trackingfield:read:admin` ### Zoom#trackingfieldCreate [src/index.js:5320-5364](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5320-L5364 "Source code on GitHub") Create a Tracking Field on your Zoom account ##### Scopes: - `trackingfield:write:admin` ### Zoom#trackingfieldGet [src/index.js:5396-5429](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5396-L5429 "Source code on GitHub") Retrieve a tracking field ##### Scopes: - `trackingfield:read:admin` #### Parameters - `fieldId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Tracking Field ID ### Zoom#trackingfieldUpdate [src/index.js:5472-5521](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5472-L5521 "Source code on GitHub") Update a Tracking Field on your Zoom account ##### Scopes: - `trackingfield:write:admin` #### Parameters - `fieldId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Tracking Field ID ### Zoom#trackingfieldDelete [src/index.js:5553-5586](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5553-L5586 "Source code on GitHub") Delete a Tracking Field on your Zoom account ##### Scopes: - `trackingfield:write:admin` #### Parameters - `fieldId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Tracking Field ID ### Zoom#imGroups [src/index.js:5613-5637](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5613-L5637 "Source code on GitHub") List [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. ##### Scopes: - `imgroup:read:admin` ### Zoom#imGroupCreate [src/index.js:5678-5722](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5678-L5722 "Source code on GitHub") Create an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. ##### Scopes: - `imgroup:write:admin` ### Zoom#imGroup [src/index.js:5755-5788](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5755-L5788 "Source code on GitHub") Retrieve an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. ##### Scopes: - `imgroup:read:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). ### Zoom#imGroupUpdate [src/index.js:5832-5881](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5832-L5881 "Source code on GitHub") Update an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. ##### Scopes: - `imgroup:write:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). ### Zoom#imGroupDelete [src/index.js:5914-5947](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5914-L5947 "Source code on GitHub") Delete an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. ##### Scopes: - `imgroup:write:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). ### Zoom#imGroupMembers [src/index.js:5991-6034](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L5991-L6034 "Source code on GitHub") List the members of an IM directory group under your account. ##### Scopes: - `imgroup:read:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#imGroupMembersCreate [src/index.js:6080-6132](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L6080-L6132 "Source code on GitHub") Add members to an IM directory group under your account. ##### Scopes: - `imgroup:write:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). ### Zoom#imGroupMembersDelete [src/index.js:6169-6210](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L6169-L6210 "Source code on GitHub") Delete a member from an IM directory group under your account. ##### Scopes: - `imgroup:write:admin` #### Parameters - `groupId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The group ID. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). - `memberId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The member ID. ### Zoom#imChatSessions [src/index.js:6262-6317](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L6262-L6317 "Source code on GitHub") Retrieve IM Chat sessions for a specified period of time. ##### Scopes: - `imchat:read, imchat:read:admin` #### Parameters - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#imChatMessages [src/index.js:6372-6435](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L6372-L6435 "Source code on GitHub") Retrieve IM chat messages for a specified period of time. ##### Scopes: - `imchat:read` #### Parameters - `sessionId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** IM chat session ID. - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#meetings [src/index.js:6484-6532](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L6484-L6532 "Source code on GitHub") List meetings for a user. ##### Scopes: - `meeting:read:admin` `meeting:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting types: `scheduled` - All the scheduled meetings.`live` - All the live meetings.`upcoming` - All the upcoming meetings. - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#meetingCreate [src/index.js:6615-6708](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L6615-L6708 "Source code on GitHub") Create a meeting for a user. ##### Scopes: - `meeting:write:admin` `meeting:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#meeting [src/index.js:6745-6783](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L6745-L6783 "Source code on GitHub") Retrieve the details of a meeting. ##### Scopes: - `meeting:read:admin` `meeting:read` #### Parameters - `meetingId` **integer** The meeting ID. - `occurrenceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Meeting occurrence id ### Zoom#meetingUpdate [src/index.js:6879-6983](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L6879-L6983 "Source code on GitHub") Update the details of a meeting. ##### Scopes: - `meeting:write:admin` `meeting:write` #### Parameters - `meetingId` **integer** The meeting ID. - `occurrenceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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} ### Zoom#meetingDelete [src/index.js:7020-7058](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7020-L7058 "Source code on GitHub") Delete a meeting. ##### Scopes: - `meeting:write:admin` `meeting:write` #### Parameters - `meetingId` **integer** The meeting ID. - `occurrenceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting occurrence ID. ### Zoom#meetingStatus [src/index.js:7097-7142](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7097-L7142 "Source code on GitHub") Update a meeting's status. ##### Scopes: - `meeting:write:admin` `meeting:write` #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#meetingRegistrants [src/index.js:7197-7250](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7197-L7250 "Source code on GitHub") List registrants of a meeting. ##### Scopes: - `meeting:read:admin` `meeting:read` #### Parameters - `meetingId` **integer** The meeting ID. - `occurrenceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting occurrence ID. - `status` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The registrant status:`pending` - Registrant's status is pending.`approved` - Registrant's status is approved.`denied` - Registrant's status is denied. - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#meetingRegistrantCreate [src/index.js:7316-7389](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7316-L7389 "Source code on GitHub") Register a participant for a meeting. ##### Scopes: - `meeting:write:admin` `meeting:write` #### Parameters - `meetingId` **integer** The meeting ID. - `occurrenceIds` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma. ### Zoom#meetingRegistrantStatus [src/index.js:7438-7493](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7438-L7493 "Source code on GitHub") Update a meeting registrant's status. ##### Scopes: - `meeting:write:admin` `meeting:write` #### Parameters - `meetingId` **integer** The meeting ID. - `occurrenceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting occurrence ID. ### Zoom#pastMeetingDetails [src/index.js:7528-7561](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7528-L7561 "Source code on GitHub") Retrieve details from a past meeting. ##### Scopes: - `meeting:read:admin` `meeting:read` > **Note**: Please double encode your UUID when using this API. #### Parameters - `meetingUuid` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting UUID. ### Zoom#pastMeetingParticipants [src/index.js:7607-7650](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7607-L7650 "Source code on GitHub") Retrieve participants from a past meeting. ##### Scopes: - `meeting:read:admin` `meeting:read` > **Note**: Please double encode your UUID when using this API. #### Parameters - `meetingUuid` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting UUID. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#pastMeetings [src/index.js:7682-7715](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7682-L7715 "Source code on GitHub") List of ended meeting instances ##### Scopes: - `meeting:read:admin` `meeting:read` #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#meetingPolls [src/index.js:7751-7784](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7751-L7784 "Source code on GitHub") List [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting ##### Scopes: - `meeting:read:admin` `meeting:read` ##### Prerequisites: Host user must be in a Pro plan. Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled. #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#meetingPollCreate [src/index.js:7833-7888](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7833-L7888 "Source code on GitHub") Create a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting ##### Scopes: - `meeting:write:admin` `meeting:write` ##### Prerequisites: Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled. #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#meetingPollGet [src/index.js:7924-7965](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L7924-L7965 "Source code on GitHub") Retrieve a meeting's [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) ##### Scopes: - `meeting:read:admin` `meeting:read` #### Parameters - `meetingId` **integer** The meeting ID. - `pollId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The poll ID ### Zoom#meetingPollUpdate [src/index.js:8012-8072](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8012-L8072 "Source code on GitHub") Update a meeting's [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) ##### Scopes: - `meeting:write:admin` `meeting:write` #### Parameters - `meetingId` **integer** The meeting ID. - `pollId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The poll ID ### Zoom#meetingPollDelete [src/index.js:8108-8149](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8108-L8149 "Source code on GitHub") Delete a meeting's [Poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) ##### Scopes: - `meeting:write:admin` `meeting:write` #### Parameters - `meetingId` **integer** The meeting ID. - `pollId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The poll ID ### Zoom#meetingRegistrantsQuestionsGet [src/index.js:8180-8213](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8180-L8213 "Source code on GitHub") List registration questions that will be displayed to users while registering for a meeeting. #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#meetingRegistrantQuestionUpdate [src/index.js:8260-8317](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8260-L8317 "Source code on GitHub") Update registration questions that will be displayed to users while registering for a meeeting. #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#recordingsList [src/index.js:8384-8447](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8384-L8447 "Source code on GitHub") List all recordings. ##### Scopes: - `user:read:admin` `user:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Query mc. - `trash` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Query trash. - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. (Within 6 month range) - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date in 'yyyy-mm-dd' format. (Within 6 month range) ### Zoom#recordingGet [src/index.js:8479-8512](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8479-L8512 "Source code on GitHub") Retrieve all the recordings from a meeting. ##### Scopes: - `recording:read:admin` `recording:read` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. ### Zoom#recordingDelete [src/index.js:8549-8587](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8549-L8587 "Source code on GitHub") Delete a meeting's recordings. ##### Scopes: - `recording:write:admin` `recording:write` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. - `action` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The recording delete actions:`trash` - Move recording to trash.`delete` - Delete recording permanently. ### Zoom#recordingDeleteOne [src/index.js:8628-8674](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8628-L8674 "Source code on GitHub") Delete one meeting recording file. ##### Scopes: - `recording:write:admin` `recording:write` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. - `recordingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The recording ID. - `action` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The recording delete actions:`trash` - Move recording to trash.`delete` - Delete recording permanently. ### Zoom#recordingStatusUpdate [src/index.js:8713-8758](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8713-L8758 "Source code on GitHub") Recover a meeting's recordings. ##### Scopes: - `recording:write:admin` `recording:write` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. ### Zoom#recordingStatusUpdateOne [src/index.js:8801-8854](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8801-L8854 "Source code on GitHub") Recover a single recording. ##### Scopes: - `recording:write:admin` `recording:write` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. - `recordingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The recording ID. ### Zoom#recordingSettingUpdate [src/index.js:8886-8919](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8886-L8919 "Source code on GitHub") Retrieve a meeting recording's settings ##### Scopes: - `recording:read:admin` `recording:read` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. ### Zoom#recordingSettingsUpdate [src/index.js:8961-9012](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L8961-L9012 "Source code on GitHub") Update a meeting recording's settings ##### Scopes: - `recording:write:admin` `recording:write` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. ### Zoom#meetingRecordingRegistrants [src/index.js:9060-9108](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L9060-L9108 "Source code on GitHub") List registrants of a meeting recording #### Parameters - `meetingId` **integer** The meeting ID. - `status` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The registrant status:`pending` - Registrant's status is pending.`approved` - Registrant's status is approved.`denied` - Registrant's status is denied. - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#meetingRecordingRegistrantCreate [src/index.js:9168-9236](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L9168-L9236 "Source code on GitHub") Register a participant for a meeting recording #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#meetingRecordingRegistrantStatus [src/index.js:9278-9327](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L9278-L9327 "Source code on GitHub") Update a meeting recording registrant's status #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#recordingRegistrantsQuestionsGet [src/index.js:9358-9391](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L9358-L9391 "Source code on GitHub") Retrieve a list of questions that are displayed for users to complete when registering to view a recording. #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. ### Zoom#recordingRegistrantQuestionUpdate [src/index.js:9438-9495](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L9438-L9495 "Source code on GitHub") Update registration questions that are to be answered by users while registering to view a recording. #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. ### Zoom#dashboardMeetings [src/index.js:9553-9613](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L9553-L9613 "Source code on GitHub") List live meetings or past meetings for a specified period of time. ##### Scopes: - `dashboard:read:admin` #### Parameters - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting types: `past` - Past meetings.`pastOne` - Past one user meetings. `live` - Live meetings. - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#dashboardMeetingDetail [src/index.js:9650-9688](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L9650-L9688 "Source code on GitHub") Retrieve details on live or past meetings. ##### Scopes: - `dashboard:read:admin` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting types: `past` - Past meetings.`pastOne` - Past one user meetings.`live` - Live meetings. ### Zoom#dashboardMeetingParticipants [src/index.js:9737-9785](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L9737-L9785 "Source code on GitHub") Retrieve a list of participants from live or past meetings. ##### Scopes: - `dashboard:read:admin` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting types: `past` - Past meetings.`pastOne` - Past one user meetings.`live` - Live meetings. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#dashboardMeetingParticipantQOS [src/index.js:9826-9872](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L9826-L9872 "Source code on GitHub") Retrieve the quality of service for participants from live or past meetings. ##### Scopes: - `dashboard:read:admin` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. - `participantId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Participant ID. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting types: `past` - Past meetings.`live` - Live Meetings. ### Zoom#dashboardMeetingParticipantsQOS [src/index.js:9921-9969](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L9921-L9969 "Source code on GitHub") Retrieve a list of meeting participants from live or past meetings and the quality of service they recieved. ##### Scopes: - `dashboard:read:admin` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting types: `past` - Past meetings.`live` - Live Meetings. - `pageSize` **integer** The number of items returned per page. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#dashboardMeetingParticipantShare [src/index.js:10018-10066](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10018-L10066 "Source code on GitHub") Retrieve the sharing and recording details of participants from live or past meetings. ##### Scopes: - `dashboard:read:admin` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting types: `past` - Past meetings.`live` - Live Meetings. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#dashboardWebinars [src/index.js:10124-10184](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10124-L10184 "Source code on GitHub") List all the live or past webinars from a specified period of time. ##### Scopes: - `dashboard:read:admin` #### Parameters - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar type. - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#dashboardWebinarDetail [src/index.js:10221-10259](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10221-L10259 "Source code on GitHub") Retrieve details from live or past webinars. ##### Scopes: - `dashboard:read:admin` #### Parameters - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar type. ### Zoom#dashboardWebinarParticipants [src/index.js:10308-10356](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10308-L10356 "Source code on GitHub") Retrieve participants from live or past webinars. ##### Scopes: - `dashboard:read:admin` #### Parameters - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar type. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#dashboardWebinarParticipantQOS [src/index.js:10397-10443](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10397-L10443 "Source code on GitHub") Retrieve the quality of service that participants from live or past webinars recieved. ##### Scopes: - `dashboard:read:admin` #### Parameters - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance. - `participantId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Participant ID. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar type. ### Zoom#dashboardWebinarParticipantsQOS [src/index.js:10492-10540](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10492-L10540 "Source code on GitHub") Retrieve a list of participants from live or past webinars and the quality of service they received. ##### Scopes: - `dashboard:read:admin` #### Parameters - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar type. - `pageSize` **integer** The number of items returned per page. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#dashboardWebinarParticipantShare [src/index.js:10589-10637](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10589-L10637 "Source code on GitHub") Retrieve the sharing and recording details of participants from live or past webinars. ##### Scopes: - `dashboard:read:admin` #### Parameters - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar type. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#dashboardZoomRooms [src/index.js:10677-10712](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10677-L10712 "Source code on GitHub") List all zoom rooms on account. ##### Scopes: - `dashboard:read:admin` #### Parameters - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#dashboardZoomRoom [src/index.js:10767-10830](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10767-L10830 "Source code on GitHub") Retrieve Zoom room on account. ##### Scopes: - `dashboard:read:admin` #### Parameters - `zoomroomId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Zoom room ID. - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#dashboardCRC [src/index.js:10870-10915](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10870-L10915 "Source code on GitHub") Get the hour by hour CRC Port usage for a specified period of time. . ##### Scopes: - `dashboard:read:admin` #### Parameters - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. ### Zoom#dashboardIM [src/index.js:10967-11022](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L10967-L11022 "Source code on GitHub") Retrieve metrics of the Zoom IM. ##### Scopes: - `dashboard:read:admin` #### Parameters - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#dashboardClientFeedback [src/index.js:11061-11106](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11061-L11106 "Source code on GitHub") Retrieve Zoom Meetings Client Feedback #### Parameters - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. ### Zoom#dashboardZoomRoomIssue [src/index.js:11145-11190](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11145-L11190 "Source code on GitHub") Retrieve Top 25 issues of Zoom Rooms #### Parameters - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. ### Zoom#dashboardIssueZoomRoom [src/index.js:11229-11274](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11229-L11274 "Source code on GitHub") Retrieve Top 25 Zoom Rooms with issues #### Parameters - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. ### Zoom#dashboardIssueDetailZoomRoom [src/index.js:11328-11391](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11328-L11391 "Source code on GitHub") Retrieve Issue detail of Top 25 Zoom Rooms with issues #### Parameters - `zoomroomId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Zoom room ID. - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#reportDaily [src/index.js:11434-11469](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11434-L11469 "Source code on GitHub") Retrieve daily report to access the account-wide usage for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes. The month selected should fall within the recent six months. ##### Prerequisites: Pro, Business, Enterprise, Education, or API Account Account owner or admin permissions ##### Scopes: - `report:read:admin` #### Parameters - `year` **integer** Year for this report - `month` **integer** Month for this report ### Zoom#reportUsers [src/index.js:11527-11587](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11527-L11587 "Source code on GitHub") Retrieve an active or inactive host report for a specified period of time. ##### Scopes: - `report:read:admin` #### Parameters - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Active or inactive hosts.`active` - Active hosts. `inactive` - Inactive hosts. - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#reportMeetings [src/index.js:11642-11705](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11642-L11705 "Source code on GitHub") Retrieve a past meeting report for a specified period of time. Meetings will only return in the response if the meeting has two or more unique participants. ##### Scopes: - `report:read:admin` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#reportMeetingDetails [src/index.js:11737-11770](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11737-L11770 "Source code on GitHub") Retrieve a detail report for a past meeting. ##### Scopes: - `report:read:admin` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. ### Zoom#reportMeetingParticipants [src/index.js:11813-11856](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11813-L11856 "Source code on GitHub") Retrieve a participant report for a past meeting. ##### Scopes: - `report:read:admin` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#reportMeetingPolls [src/index.js:11888-11921](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11888-L11921 "Source code on GitHub") Retrieve a report of [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) results for a past meeting. ##### Scopes: - `report:read:admin` #### Parameters - `meetingId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance. ### Zoom#reportWebinarDetails [src/index.js:11953-11986](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L11953-L11986 "Source code on GitHub") Retrieve a report containing past webinar details. ##### Scopes: - `report:read:admin` #### Parameters - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance. ### Zoom#reportWebinarParticipants [src/index.js:12029-12072](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12029-L12072 "Source code on GitHub") Retrieve a report on webinar participants. ##### Scopes: - `report:read:admin` #### Parameters - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#reportWebinarPolls [src/index.js:12104-12137](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12104-L12137 "Source code on GitHub") Retrieve a report on past [webinar polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars). ##### Scopes: - `report:read:admin` #### Parameters - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance. ### Zoom#reportWebinarQA [src/index.js:12169-12202](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12169-L12202 "Source code on GitHub") Retrieve a report on past webinar Q&As. ##### Scopes: - `report:read:admin` #### Parameters - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance. ### Zoom#reportTelephone [src/index.js:12257-12314](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12257-L12314 "Source code on GitHub") Retrieve a telephone report for a specified period of time. . ##### Scopes: - `report:read:admin` #### Parameters - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#reportCloudRecording [src/index.js:12353-12398](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12353-L12398 "Source code on GitHub") Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day ealier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days. #### Parameters - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. ### Zoom#reportOperationLogs [src/index.js:12449-12504](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12449-L12504 "Source code on GitHub") Retrieve operation logs report #### Parameters - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Start date in 'yyyy-mm-dd' format. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** End date. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#roles [src/index.js:12536-12560](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12536-L12560 "Source code on GitHub") List Roles on your account ##### Scopes: - `role:read:admin` ##### Prerequisites: 1. Pro, Business, Education, or Enterprise account. 2. For setting the initial role, you must be the Account Owner. 3. For subsequent role management, you must be the Account Owner or user with role management permissions. ### Zoom#createRole [src/index.js:12605-12643](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12605-L12643 "Source code on GitHub") Each Zoom user automatically has a role which can either be owner, administrator, or a member. ##### Prerequisites: An Enterprise, Business, Education or Pro plan. For setting the initial role, you must be the Account Owner. For subsequent role management, you must be the Account Owner or user with role management permissions. ##### Scopes: - `role:write:admin` ### Zoom#roleMembers [src/index.js:12676-12709](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12676-L12709 "Source code on GitHub") List all the members in a specific role. ##### Scopes: - `role:read:admin` #### Parameters - `roleId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The role ID ### Zoom#AddRoleMembers [src/index.js:12752-12804](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12752-L12804 "Source code on GitHub") Assign members to a role. ##### Scopes: - `role:write:admin` #### Parameters - `roleId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The role ID ### Zoom#roleMemberDelete [src/index.js:12841-12882](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12841-L12882 "Source code on GitHub") Delete a specific member from a specific role. ##### Scopes: - `role:write:admin` #### Parameters - `roleId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The role ID - `memberId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Member's ID ### Zoom#tsp [src/index.js:12909-12933](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12909-L12933 "Source code on GitHub") Retrieve TSP information on account level ##### Scopes: - `tsp:read:admin` `tsp:read` ### Zoom#tspUpdate [src/index.js:12970-13012](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L12970-L13012 "Source code on GitHub") Update TSP information on account level ##### Scopes: - `tsp:write:admin` `tsp:write` ### Zoom#users [src/index.js:13064-13109](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13064-L13109 "Source code on GitHub") List users on your account. ##### Scopes: - `user:read:admin` #### Parameters - `status` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** User statuses:`active` - Users with an active status.`inactive` - Users with an inactive status.`pending` - Users with a pending status. - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. - `roleId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The role Id ### Zoom#userCreate [src/index.js:13150-13197](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13150-L13197 "Source code on GitHub") Create a user using your account. ##### Scopes: - `user:write:admin` `user:write` ### Zoom#user [src/index.js:13234-13272](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13234-L13272 "Source code on GitHub") Retrieve a user on your account. ##### Scopes: - `user:read:admin` `user:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `loginType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** `0` - Facebook`1` - Google`99` - API`100` - Zoom`101` - SSO ### Zoom#userUpdate [src/index.js:13324-13384](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13324-L13384 "Source code on GitHub") Update a user on your account. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `loginType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** `0` - Facebook`1` - Google`99` - API`100` - Zoom`101` - SSO ### Zoom#userDelete [src/index.js:13445-13503](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13445-L13503 "Source code on GitHub") Delete a user on your account. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `action` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Delete action options:`disassociate` - Disassociate a user.`delete`- Permanently delete a user.Note: To delete pending user in the account, use `disassociate` - `transferEmail` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Transfer email. - `transferMeeting` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Transfer meeting. - `transferWebinar` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Transfer webinar. - `transferRecording` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Transfer recording. ### Zoom#userAssistants [src/index.js:13539-13572](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13539-L13572 "Source code on GitHub") List user assistants. Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege) on the user's behalf. ##### Prerequisites: Assistants must be under the current user's account. ##### Scopes: - `user:read:admin` `user:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userAssistantCreate [src/index.js:13618-13670](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13618-L13670 "Source code on GitHub") Add assistants to a user. Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege) on the user's behalf. ##### Prerequisites: Assistants must be under the current user's account. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userAssistantsDelete [src/index.js:13706-13739](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13706-L13739 "Source code on GitHub") Delete all user assistants. Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege) on the user's behalf. ##### Prerequisites: Assistants must be under the current user's account. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userAssistantDelete [src/index.js:13779-13820](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13779-L13820 "Source code on GitHub") Delete a specific assistant. Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege) on the user's behalf. ##### Prerequisites: Assistants must be under the current user's account. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `assistantId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Assistant ID. ### Zoom#userSchedulers [src/index.js:13856-13889](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13856-L13889 "Source code on GitHub") List a user's schedulers. Schedulers in this context are the users on whose behalf the current user can [schedule](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege) meetings for. ##### Prerequisites: Current user must be under the same account as the scheduler. ##### Scopes: - `user:read:admin` `user:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userSchedulersDelete [src/index.js:13925-13958](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13925-L13958 "Source code on GitHub") Delete all of a user's schedulers. Schedulers in this context are the users on whose behalf the current user can [schedule](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege) meetings for. ##### Prerequisites: Current user must be under the same account as the scheduler. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userSchedulerDelete [src/index.js:13998-14039](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L13998-L14039 "Source code on GitHub") Delete one of the user's schedulers. Schedulers in this context are the users on whose behalf the current user can [schedule](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege) meetings for. ##### Prerequisites: Current user must be under the same account as the scheduler. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `schedulerId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Scheduler's ID. ### Zoom#userPicture [src/index.js:14086-14132](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L14086-L14132 "Source code on GitHub") Upload a user's profile picture. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `picFile` **file** “Content-Type: multipart/form-data; boundary=$boundary” (where $boundary is the unique, semi-random string that does not occur within the file contents). In place of a JSON request body, the multipart/form-data request body looks like this: --$boundary Content-Disposition: form-data; name="pic_file"; filename="$filename" Content-Type: image/jpeg $filecontents --$boundary--It’s also important to note that the line endings are `\r\n` between the lines ### Zoom#userSettings [src/index.js:14169-14207](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L14169-L14207 "Source code on GitHub") Retrieve a user's settings. ##### Scopes: - `user:read:admin` `user:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `loginType` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** `0` - Facebook`1` - Google`99` - API`100` - Zoom`101` - SSO ### Zoom#userSettingsUpdate [src/index.js:14320-14442](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L14320-L14442 "Source code on GitHub") Update a user's settings. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userStatus [src/index.js:14478-14523](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L14478-L14523 "Source code on GitHub") Update a user's status. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userPassword [src/index.js:14559-14604](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L14559-L14604 "Source code on GitHub") Update a user password. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userPermission [src/index.js:14636-14669](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L14636-L14669 "Source code on GitHub") Retrieve a user's permissions. ##### Scopes: - `user:read:admin` `user:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userPACs [src/index.js:14701-14734](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L14701-L14734 "Source code on GitHub") List a user's PAC accounts. ##### Scopes: - `user:read:admin` `user:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userTSPs [src/index.js:14766-14799](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L14766-L14799 "Source code on GitHub") A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user. ##### Scopes: - `tsp:read:admin` `tsp:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userTSPCreate [src/index.js:14845-14901](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L14845-L14901 "Source code on GitHub") Add a user's TSP account. ##### Scopes: - `tsp:write:admin` `tsp:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userTSP [src/index.js:14937-14978](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L14937-L14978 "Source code on GitHub") Each user can have a maximum of two TSP accounts. Use this API to retrieve one specific TSP account of a user. ##### Scopes: - `tsp:read:admin` `tsp:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `tspId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** TSP account ID. ### Zoom#userTSPUpdate [src/index.js:15026-15087](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15026-L15087 "Source code on GitHub") Update a user's TSP account. ##### Scopes: - `tsp:write:admin` `tsp:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `tspId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** TSP account ID. ### Zoom#userTSPDelete [src/index.js:15123-15164](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15123-L15164 "Source code on GitHub") Delete a user's TSP account. ##### Scopes: - `tsp:write:admin` `tsp:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `tspId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** TSP account ID. ### Zoom#userToken [src/index.js:15201-15239](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15201-L15239 "Source code on GitHub") Retrieve a user's token. ##### Scopes: - `user:read:admin` `user:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** User token types:`token` - Used for starting meetings with the client SDK.`zpk` - Used for generating the start meeting URL (Deprecated).`zak` - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days. ### Zoom#userSSOTokenDelete [src/index.js:15271-15304](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15271-L15304 "Source code on GitHub") Revoke a user's SSO token. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userEmail [src/index.js:15338-15373](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15338-L15373 "Source code on GitHub") Verify if a user's email is registered with Zoom. ##### Scopes: - `user:read:admin` `user:read` #### Parameters - `email` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The email address to be verified. ### Zoom#userEmailUpdate [src/index.js:15409-15454](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15409-L15454 "Source code on GitHub") Update a user's email. ##### Scopes: - `user:write:admin` `user:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#userVanityName [src/index.js:15488-15523](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15488-L15523 "Source code on GitHub") Check if the user's personal meeting room name exists. ##### Scopes: - `user:read:admin` `user:read` #### Parameters - `vanityName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Personal meeting room name. ### Zoom#webinars [src/index.js:15566-15609](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15566-L15609 "Source code on GitHub") List webinars for a user. ##### Scopes: - `webinar:read:admin` `webinar:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. ### Zoom#webinarCreate [src/index.js:15689-15779](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15689-L15779 "Source code on GitHub") Create a webinar for a user. ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. ### Zoom#webinar [src/index.js:15816-15854](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15816-L15854 "Source code on GitHub") Retrieve a webinar. ##### Scopes: - `webinar:read:admin` `webinar:read` #### Parameters - `webinarId` **integer** The webinar ID. - `occurrenceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Webinar occurrence id ### Zoom#webinarUpdate [src/index.js:15939-16032](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L15939-L16032 "Source code on GitHub") Update a webinar. ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. - `occurrenceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Webinar occurrence id. Support change of agenda, start_time, duration, settings: {host_video, panelist_video, hd_video, watermark, auto_recording} ### Zoom#webinarDelete [src/index.js:16069-16107](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16069-L16107 "Source code on GitHub") Delete a webinar. ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. - `occurrenceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting occurrence ID. ### Zoom#webinarStatus [src/index.js:16146-16191](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16146-L16191 "Source code on GitHub") Update a webinar's status. You can call this API to end an ongoing webinar. ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. ### Zoom#webinarPanelists [src/index.js:16223-16256](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16223-L16256 "Source code on GitHub") List panelists for a webinar. ##### Scopes: - `webinar:read:admin` `webinar:read` #### Parameters - `webinarId` **integer** The webinar ID. ### Zoom#webinarPanelistCreate [src/index.js:16301-16353](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16301-L16353 "Source code on GitHub") Add panelists to a webinar. ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. ### Zoom#webinarPanelistsDelete [src/index.js:16385-16418](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16385-L16418 "Source code on GitHub") Remove all panelists from a webinar. ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. ### Zoom#webinarPanelistDelete [src/index.js:16454-16495](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16454-L16495 "Source code on GitHub") Remove a panelist from a webinar. ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. - `panelistId` **integer** The panelist ID or panelist email. ### Zoom#webinarRegistrants [src/index.js:16557-16618](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16557-L16618 "Source code on GitHub") List registrants for a webinar. ##### Scopes: - `webinar:read:admin` `webinar:read` #### Parameters - `webinarId` **integer** The webinar ID. - `occurrenceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting occurrence ID. - `status` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The registrant status:`pending` - Registrant's status is pending.`approved` - Registrant's status is approved.`denied` - Registrant's status is denied. - `pageSize` **integer** The number of records returned within a single API call. - `pageNumber` **integer** The current page number of returned records. - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.For instance you can list all users on an account via `https://api.zoom.us/v2/users/`. ### Zoom#webinarRegistrantCreate [src/index.js:16691-16772](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16691-L16772 "Source code on GitHub") Add a registrant for a webinar. ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. - `occurrenceIds` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Occurrence ID. Get this value from the webinar get API. Multiple values separated by a comma. - `webinarId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.For instance you can list all users on an account via `https://api.zoom.us/v2/users/`. ### Zoom#webinarRegistrantStatus [src/index.js:16821-16876](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16821-L16876 "Source code on GitHub") Update a webinar registrant's status. ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. - `occurrenceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The meeting occurrence ID. ### Zoom#pastWebinars [src/index.js:16908-16941](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16908-L16941 "Source code on GitHub") List of past webinar instances. ##### Scopes: - `webinar:read:admin` `webinar:read` #### Parameters - `webinarId` **integer** The webinar ID. ### Zoom#webinarPolls [src/index.js:16973-17006](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L16973-L17006 "Source code on GitHub") List [polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a webinar ##### Scopes: - `webinar:read:admin` `webinar:read` #### Parameters - `webinarId` **integer** The webinar ID. ### Zoom#webinarPollCreate [src/index.js:17051-17106](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17051-L17106 "Source code on GitHub") Create a [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) for a webinar ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. ### Zoom#webinarPollGet [src/index.js:17142-17183](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17142-L17183 "Source code on GitHub") Retrieve a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars). ##### Scopes: - `webinar:read:admin` `webinar:read` #### Parameters - `webinarId` **integer** The webinar ID. - `pollId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The poll ID ### Zoom#webinarPollUpdate [src/index.js:17230-17290](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17230-L17290 "Source code on GitHub") Update a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars). ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. - `pollId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The poll ID ### Zoom#webinarPollDelete [src/index.js:17326-17367](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17326-L17367 "Source code on GitHub") Delete a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars). ##### Scopes: - `webinar:write:admin` `webinar:write` #### Parameters - `webinarId` **integer** The webinar ID. - `pollId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The poll ID ### Zoom#webinarRegistrantsQuestionsGet [src/index.js:17398-17431](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17398-L17431 "Source code on GitHub") List registration questions and fields that are to be answered by users while registering for a webinar. #### Parameters - `webinarId` **integer** The webinar ID. ### Zoom#webinarRegistrantQuestionUpdate [src/index.js:17480-17537](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17480-L17537 "Source code on GitHub") Update registration questions and fields that are to be answered by users while registering for a webinar. ##### Prerequisites: Registration option for webinar should be set as required to use this API. #### Parameters - `webinarId` **integer** The webinar ID. ### Zoom#sendchatbot [src/index.js:17577-17615](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17577-L17615 "Source code on GitHub") Send chatbot messages from your marketplace chatbot app. ##### Scopes: - `imchat:bot` ### Zoom#getchatchannels [src/index.js:17652-17685](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17652-L17685 "Source code on GitHub") `This endpoint will be deprecated by the end of June 2019.` Return a user's subscribed channels with IDs. ##### Scopes: - `imcontact:read:admin` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.For instance you can list all users on an account via `https://api.zoom.us/v2/users/`. ### Zoom#meetingInvitation [src/index.js:17717-17750](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17717-L17750 "Source code on GitHub") Retrieve the meeting invitation. ##### Scopes: - `meeting:read:admin` `meeting:read` #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#meetingLiveStreamUpdate [src/index.js:17788-17835](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17788-L17835 "Source code on GitHub") Update a meeting's live stream. ##### Scopes: - `meeting:write:admin` `meeting:write` #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#meetingLiveStreamStatusUpdate [src/index.js:17875-17924](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17875-L17924 "Source code on GitHub") Update a meeting's live stream status. ##### Scopes: - `meeting:write:admin` `meeting:write` #### Parameters - `meetingId` **integer** The meeting ID. ### Zoom#dashboardClientFeedbackDetail [src/index.js:17990-18043](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L17990-L18043 "Source code on GitHub") Retrieve Zoom Meetings Client Feedback Detail #### Parameters - `feedbackId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Feedback Detail Id - `from` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.For instance you can list all users on an account via `https://api.zoom.us/v2/users/`. - `to` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.For instance you can list all users on an account via `https://api.zoom.us/v2/users/`. - `pageSize` **integer** The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.For instance you can list all users on an account via `https://api.zoom.us/v2/users/`. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.For instance you can list all users on an account via `https://api.zoom.us/v2/users/`. ### Zoom#listimmessages [src/index.js:18104-18162](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L18104-L18162 "Source code on GitHub") Retrieve IM Chat messages for a specified period of time. ##### Scopes: - `imchat:read` #### Parameters - `userId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The user ID or email address. - `chatUser` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Chat user's ID or email address. - `channel` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** IM Channel's ID. - `date` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** IM message's query date time, format as yyyy-MM-dd. - `pageSize` **integer** The number of records returned within a single API call. - `nextPageToken` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 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. ### Zoom#sendimmessages [src/index.js:18204-18244](https://github.com/bunchtogether/zoom-api-v2/blob/f5b83524495f084f6a4f7f050ad89a642023e502/src/index.js#L18204-L18244 "Source code on GitHub") Send chat messages between two users.