Zoom API MCP Server

{ "server": { "url": "https://api.zoom.us/v2" }, "authentication": [ { "schema_parameters": { "in": "header" }, "type": "apiKey", "value": "API_KEY" } ], "operations": [ { "description": "List all the sub accounts that have been created by a master account.\u003cbr\u003e\u003cbr\u003eZoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts. Email the partner programs team at **partner-success@zoom.us** for more details. \u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**: `account:read:admin` \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "accounts" }, { "description": "Get details of a sub account that is listed under a master account. Your account must be a master account in order to retrieve sub accounts\u0027 details. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and create sub accounts. Email the partner programs team at **partner-success@zoom.us** for more details. **Prerequisites:** * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**: `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "account" }, { "description": "[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to retrieve an account\u0027s locked settings. **Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled. \u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Pro or a higher paid account. \u003cbr\u003e **Scope**: `account:read:admin`. \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Scope:** account:read:admin", "name": "get_account_lock_settings" }, { "description": "[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to update an account\u0027s locked settings. **Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher paid account. \u003cbr\u003e **Scope:** `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e", "name": "update_account_lock_settings" }, { "description": "Get a sub account\u0027s [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-).\u003cbr\u003e\u003cbr\u003e **Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled. \u003cbr\u003e\u003cbr\u003e To get managed domains of the master account, provide `me` as the value for accountId in the path parameter. Provide the sub account\u0027s Account ID as the value of accountId path parameter to get managed domains of the sub account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope:** `account:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "account_managed_domain" }, { "description": "Update a sub account\u0027s options under the master account.\u003cbr\u003e \u003caside\u003eYour account must be a master account in order to update the options for sub accounts. Zoom only assigns this privilege to trusted partners. \u003c/aside\u003e **Prerequisites:** * Pro or a higher paid account with master account option enabled. * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis).\u003cbr\u003e\u003cbr\u003e **Scope**: `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "account_options_update" }, { "description": "The current account owner can [change the owner of an account](https://support.zoom.us/hc/en-us/articles/115005686983-Change-Account-Owner) to another user on the same account.\u003cbr\u003e Use this API to change the owner of a sub account. **Prerequisites**: \u003cbr\u003e * Account owner or admin permissions of an account. * The account making this API request must be on a pro or a hiigher plan with [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) privilege.\u003cbr\u003e\u003cbr\u003e **Scopes:** `account:write:admin` or `account:master`\u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e \u003cbr\u003e", "name": "update_account_owner" }, { "description": "Only [master account owners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) can use this API to enable BYOC(Bring your own carrier) option for a sub account.\u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:master` \u003cbr\u003e **Prerequisites**: \u003cbr\u003e * Business or enterprise Account.\u003cbr\u003e", "name": "update_phone_settings" }, { "description": "Get the settings of an account.\u003cbr\u003e To get the settings of a master account, use `me` as the value for the `accountId` path parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * The account must be a paid account.\u003cbr\u003e **Scopes**: `account:read:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "account_settings" }, { "description": "Update the settings of a sub account that is under a master account.\u003cbr\u003e To update the settings of the master account, use `me` as the value of the `accountId` path parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * The sub account must be a paid account.\u003cbr\u003e **Scopes**: `account:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "account_settings_update" }, { "description": "Get trusted domains of a sub account. To get the trusted domains of a master account, use `me` as the value for the `accountId` path parameter. **Prerequisites:**\u003cbr\u003e * The sub account must be a paid account.\u003cbr\u003e **Scope:** `account:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "account_trusted_domain" }, { "description": "List [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro or higher account.\u003cbr\u003e **Scopes**: `group:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "groups" }, { "description": "Retrieve a [group\u0027s](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. \u003cp style=\"background-color:#FEEFB3; color:#9F6000\"\u003e\u003cbr\u003eNote:\u003c/b\u003e The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.\u003c/p\u003e **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_group_lock_settings" }, { "description": "Update a [group\u0027s](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. \u003cp style=\"background-color:#FEEFB3; color:#9F6000\"\u003e\u003cbr\u003eNote:\u003c/b\u003e The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.\u003c/p\u003e **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "group_locked_settings" }, { "description": "Update settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).\u003cp style=\"background-color:#FEEFB3; color:#9F6000\"\u003e\u003cbr\u003eNote:\u003c/b\u003e The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.\u003c/p\u003e **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_group_settings" }, { "description": "A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. Use this API to get the hour by hour CRC Port usage for a specified period of time. \u003caside class=\u0027notice\u0027\u003eWe will provide the report for a maximum of one month. For example, if \"from\" is set to \"2017-08-05\" and \"to\" is set to \"2017-10-10\", we will adjust \"from\" to \"2017-09-10\".\u003c/aside\u003e\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan. * Room Connector must be enabled on the account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_crc:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`", "name": "dashboard_c_r_c" }, { "description": "This API lets you retrieve a list of all the phone template settings previously created. \u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:read:admin` or `phone:read` \u003cbr\u003e**Prerequisites**: \u003cbr\u003e 1. Business or enterprise Account 2. A Zoom Phone license \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "list_setting_templates" }, { "description": "Retrieve a user\u0027s [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` **Prerequisites** : 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user" }, { "description": "Update a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user\u0027s profile. **Scopes:** `phone:write` `phone:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "update_user_profile" }, { "description": "Retrieve a user\u0027s zoom phone profile [settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings). **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user_settings" }, { "description": "Remove the shared voicemail access settings that were previously assigned to a user. To view these settings in your Zoom web portal, navigate to **Admin \u003ePhone System Management\u003e Users \u0026 Rooms**. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail \u0026 Call Recordings**.\u003cbr\u003e **Scope**: `phone:write:admin`\u003cbr\u003e\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Business or enterprise Account\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "delete_user_setting" }, { "description": "Phone users can access [shared voicemail inboxes](https://support.zoom.us/hc/en-us/articles/360033863991-Sharing-and-controlling-access-to-a-voicemail-inbox) in the Zoom desktop client, web portal, or provisioned desk phone. Use this API to define the voicemail access permissions of a user. To view these settings in the Zoom web portal, navigate to **Admin \u003ePhone System Management\u003e Users \u0026 Rooms**. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail \u0026 Call Recordings**.\u003cbr\u003e **Scope**:`phone:write:admin`\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites**: \u003cbr\u003e Business or Enterprise Account", "name": "add_user_setting" }, { "description": "Update information on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To update information on an individual Room Profile, use [Update Zoom Room Profile API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/updatezrprofile) instead. **Prerequisites:**\u003cbr\u003e * Zoom account owner or Zoom Rooms admin permissions\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_z_r_acc_profile" }, { "description": "Get details on Account Settings of a Zoom Room. With this API, you can view either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms account. By default, only **Account Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_z_r_account_settings" }, { "description": "Update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms account by specifying the required setting type in the `setting_type` parameter. To update only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter and to update only **Account Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_zoom_room_acc_settings" }, { "description": "Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "get_z_r_location_settings" }, { "description": "Update information on either meeting or alert settings applied to Zoom Rooms located in a specific location. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. Similarly, to update **Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "update_z_r_location_settings" }, { "description": "A personal meeting room is a virtual meeting room that can be permanently assigned to a user. Use this API to check if a personal meeting room with the given name exists or not.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "user_vanity_name" }, { "description": "[Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC) allows Pro or higher account holders to host meetings through PSTN (phone dial-in) only.\u003cbr\u003eUse this API to list a user\u0027s PAC accounts.\u003cbr\u003e\u003cbr\u003e **Scopes:** `pac:read:admin` `pac:read`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * A Pro or higher plan with [Premium Audio Conferencing](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) add-on. * Personal Audio Conference must be enabled in the user\u0027s profile.", "name": "user_p_a_cs" }, { "description": "Retrieve a user\u0027s settings.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "user_settings" }, { "description": "Update a user\u0027s settings.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "user_settings_update" } ] }