openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 3.33 MB

JSON

{"openapi":"3.0.0","servers":[{"url":"https://api.zoom.us/v2"}],"info":{"contact":{"email":"developersupport@zoom.us","name":"Zoom Developers","url":"https://developer.zoom.us/","x-twitter":"zoom_us"},"description":"The Zoom API allows developers to 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).\nAll endpoints are available via `https` and are located at `api.zoom.us/v2/`.\n\nFor instance you can list all users on an account via `https://api.zoom.us/v2/users/`.","license":{"name":"MIT for OAS 2.0","url":"https://opensource.org/licenses/MIT"},"termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","title":"Zoom API","version":"2.0.0","x-apisguru-categories":["telecom"],"x-logo":{"url":"https://twitter.com/zoom_us/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://marketplace.zoom.us/docs/api-reference/zoom-api/Zoom%20API.oas2.json","version":"3.0"}],"x-providerName":"zoom.us"},"security":[{"OAuth":[]}],"tags":[{"description":"Account operations","name":"Accounts"},{"description":"Billing operations","name":"Billing"},{"name":"Chat Channels"},{"name":"Chat Channels (Account-level)"},{"description":"Chat Messages operations","name":"Chat Messages"},{"name":"Chatbot Messages"},{"description":"Contacts operations","name":"Contacts"},{"description":"Cloud Recording operations","name":"Cloud Recording"},{"description":"Dashboard operations","name":"Dashboards"},{"name":"Data Compliance"},{"description":"H323 Device operations","name":"Devices"},{"description":"Group operations","name":"Groups"},{"description":"IM Chat operations","name":"IM Chat"},{"description":"IM Group operations","name":"IM Groups"},{"description":"Meeting operations","name":"Meetings"},{"description":"PAC operations","name":"PAC"},{"name":"Phone"},{"name":"Phone Auto Receptionists"},{"name":"Phone Blocked List"},{"name":"Phone Call Queues"},{"name":"Phone Devices"},{"name":"Phone Reports"},{"name":"Phone Shared Line Groups"},{"name":"Phone Site"},{"name":"Common Area Phones"},{"description":"Report operations","name":"Reports"},{"description":"User Roles","name":"Roles"},{"description":"ZoomRooms operations","name":"Rooms"},{"name":"Rooms Account"},{"name":"Rooms Location"},{"name":"SIP Phone"},{"description":"Tracking Field operations","name":"TrackingField"},{"description":"TSP operations","name":"TSP"},{"description":"User operations","name":"Users"},{"description":"Webhook operations","name":"Webhooks"},{"description":"Webinar operations","name":"Webinars"},{"description":"APIs available to the master account for a Zoom account.","name":"master account APIs"},{"name":"Rooms Devices"},{"name":"SIP Connected Audio"},{"name":"Deprecated API Endpoints"}],"paths":{"/accounts":{"get":{"description":"List all the sub accounts that have been created by a master account. Zoom 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.\n\n **Prerequisites:** \n* Pro or a higher paid account with master account option enabled. \n\n**Scope**: `account:read:admin`\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \n\n","operationId":"accounts","parameters":[{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer"}},{"description":"\n**Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use \"next_page_token\" for pagination instead of this field.\n\nThe page number of the current page in the returned records.","in":"query","name":"page_number","schema":{"default":1,"type":"integer"}},{"description":"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.","in":"query","name":"next_page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"accounts":[{"account_name":"string","account_type":"string","created_at":"string [date-time]","id":"string [uuid]","owner_email":"string","seats":"integer","subscription_end_time":"string [date-time]","subscription_start_time":"string [date-time]"}],"page_count":"integer","page_number":"integer","page_size":"integer","total_records":"integer"}}},"schema":{"allOf":[{"description":"Pagination Object.","properties":{"next_page_token":{"description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","type":"string"},"page_count":{"description":"The number of pages returned for the request made.","type":"integer"},"page_number":{"default":1,"description":"**Deprecated**: This field has been deprecated. Please use the \"next_page_token\" field for pagination instead of this field.\n\nThe page number of the current results.","type":"integer"},"page_size":{"default":30,"description":"The number of records returned with a single API call.","maximum":300,"type":"integer"},"total_records":{"description":"The total number of all the records available across pages.","type":"integer"}},"type":"object"},{"description":"Account object in the account list.","properties":{"accounts":{"description":"List of Account objects.","items":{"properties":{"account_name":{"description":"Account name.","type":"string"},"account_number":{"description":"Account Number of the account.","type":"string"},"account_type":{"description":"Account type.","type":"string"},"created_at":{"description":"Account creation date and time.","format":"date-time","type":"string"},"id":{"description":"Account ID.","type":"string"},"owner_email":{"description":"Account owner email.","example":"john.doe@zoom.us","type":"string"},"seats":{"description":"Account seats.","type":"integer"},"subscription_end_time":{"description":"Account subscription end date and time.","format":"date-time","type":"string"},"subscription_start_time":{"description":"Account subscription start date and time.","format":"date-time","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}],"description":"List of Accounts.","title":"Account List","type":"object"}},"application/xml":{"schema":{"allOf":[{"description":"Pagination Object.","properties":{"next_page_token":{"description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","type":"string"},"page_count":{"description":"The number of pages returned for the request made.","type":"integer"},"page_number":{"default":1,"description":"**Deprecated**: This field has been deprecated. Please use the \"next_page_token\" field for pagination instead of this field.\n\nThe page number of the current results.","type":"integer"},"page_size":{"default":30,"description":"The number of records returned with a single API call.","maximum":300,"type":"integer"},"total_records":{"description":"The total number of all the records available across pages.","type":"integer"}},"type":"object"},{"description":"Account object in the account list.","properties":{"accounts":{"description":"List of Account objects.","items":{"properties":{"account_name":{"description":"Account name.","type":"string"},"account_number":{"description":"Account Number of the account.","type":"string"},"account_type":{"description":"Account type.","type":"string"},"created_at":{"description":"Account creation date and time.","format":"date-time","type":"string"},"id":{"description":"Account ID.","type":"string"},"owner_email":{"description":"Account owner email.","example":"john.doe@zoom.us","type":"string"},"seats":{"description":"Account seats.","type":"integer"},"subscription_end_time":{"description":"Account subscription end date and time.","format":"date-time","type":"string"},"subscription_start_time":{"description":"Account subscription start date and time.","format":"date-time","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}],"description":"List of Accounts.","title":"Account List","type":"object"}}},"description":"Account list returned."}},"summary":"List sub accounts","tags":["Accounts"]},"post":{"description":"Create a sub account under a master account. Your account must be a master account in order to create sub accounts. \n Zoom 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. Please note that the created account user will receive a confirmation email. \n \n**Prerequisites:** \n* Pro or a higher paid account with master account option enabled. \n\n**Scope**: `account:write:admin` \n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n\n ","operationId":"accountCreate","requestBody":{"content":{"application/json":{"schema":{"description":"The account object represents an account on Zoom. The account owner is the user who created the account or had an account created for them. You can read more about the Zoom account structure <a href='https://medium.com/zoom-developer-blog/a-brief-look-at-zoom-account-structures-1d19c745bf8a' target='_blank'>here</a>.","properties":{"account_name":{"description":"Name of the account. If you do not provide a value for this field, by default, the value will be set as a concatenation of \"first_name\" and \"last_name\". ","maxLength":64,"type":"string"},"email":{"description":"User's email address.","maxLength":128,"type":"string"},"first_name":{"description":"User's first name.","maxLength":64,"type":"string"},"last_name":{"description":"User's last name.","maxLength":64,"type":"string"},"options":{"description":"Account options object.","properties":{"billing_auto_renew":{"description":"Toggle whether automatic billing renewal is on or off.","type":"boolean"},"meeting_connector_list":{"description":"Specify the IP addresses of the Meeting Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Meeting Connectors of a master account will be shared with the sub account.\n\n\n**Note:** This option can only be used if the value of `share_mc` is set to `true`.","items":{"type":"string"},"type":"array"},"pay_mode":{"default":"master","description":"Payee: `master` - master account holder pays. `sub` - Sub account holder pays.","enum":["master","sub"],"type":"string","x-enum-descriptions":["master account holder pays","Sub account holder pays"]},"room_connector_list":{"description":"Specify the IP addresses of the Room Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Room Connectors of a master account will be shared with the sub account.\n\n\n**Note:** This option can only be used if the value of `share_rc` is set to `true`.","items":{"type":"string"},"type":"array"},"share_mc":{"default":false,"description":"Enable/disable the option for a sub account to use shared [Meeting Connector(s)](https://support.zoom.us/hc/en-us/articles/201363093-Getting-Started-with-the-Meeting-Connector) that are set up by the master account. Meeting Connectors can only be used by On-prem users.","type":"boolean"},"share_rc":{"default":false,"description":"Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.","type":"boolean"}},"type":"object"},"password":{"description":"User's password.\n\n**Note:** If the account owner or admin has enabled [enhanced password requirements](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_fa9186e4-6818-4f7a-915c-2e25c19f0acd), the value provided in this field must meet those requirements. These requirements can be retrieved by calling the [Get Account Settings API](https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/accountsettings) and referring to the `password_requirement` field present in the `security` object.","minimum":8,"type":"string"}},"required":["first_name","last_name","email","password"],"type":"object"}},"multipart/form-data":{"schema":{"description":"The account object represents an account on Zoom. The account owner is the user who created the account or had an account created for them. You can read more about the Zoom account structure <a href='https://medium.com/zoom-developer-blog/a-brief-look-at-zoom-account-structures-1d19c745bf8a' target='_blank'>here</a>.","properties":{"account_name":{"description":"Name of the account. If you do not provide a value for this field, by default, the value will be set as a concatenation of \"first_name\" and \"last_name\". ","maxLength":64,"type":"string"},"email":{"description":"User's email address.","maxLength":128,"type":"string"},"first_name":{"description":"User's first name.","maxLength":64,"type":"string"},"last_name":{"description":"User's last name.","maxLength":64,"type":"string"},"options":{"description":"Account options object.","properties":{"billing_auto_renew":{"description":"Toggle whether automatic billing renewal is on or off.","type":"boolean"},"meeting_connector_list":{"description":"Specify the IP addresses of the Meeting Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Meeting Connectors of a master account will be shared with the sub account.\n\n\n**Note:** This option can only be used if the value of `share_mc` is set to `true`.","items":{"type":"string"},"type":"array"},"pay_mode":{"default":"master","description":"Payee: `master` - master account holder pays. `sub` - Sub account holder pays.","enum":["master","sub"],"type":"string","x-enum-descriptions":["master account holder pays","Sub account holder pays"]},"room_connector_list":{"description":"Specify the IP addresses of the Room Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Room Connectors of a master account will be shared with the sub account.\n\n\n**Note:** This option can only be used if the value of `share_rc` is set to `true`.","items":{"type":"string"},"type":"array"},"share_mc":{"default":false,"description":"Enable/disable the option for a sub account to use shared [Meeting Connector(s)](https://support.zoom.us/hc/en-us/articles/201363093-Getting-Started-with-the-Meeting-Connector) that are set up by the master account. Meeting Connectors can only be used by On-prem users.","type":"boolean"},"share_rc":{"default":false,"description":"Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.","type":"boolean"}},"type":"object"},"password":{"description":"User's password.\n\n**Note:** If the account owner or admin has enabled [enhanced password requirements](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_fa9186e4-6818-4f7a-915c-2e25c19f0acd), the value provided in this field must meet those requirements. These requirements can be retrieved by calling the [Get Account Settings API](https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/accountsettings) and referring to the `password_requirement` field present in the `security` object.","minimum":8,"type":"string"}},"required":["first_name","last_name","email","password"],"type":"object"}}},"description":"Account.","required":true,"x-examples":{"application/json":{"email":"fhjdhf@djhfjdf.ff","first_name":"Harry","last_name":"Ghim","options":{"meeting_connectors":["100.0.0.1","100.1.1.0"],"pay_mode":"master","room_connectors":["127.0.0.1","127.1.1.0"],"share_mc":true,"share_rc":true},"password":"bdkfhds1e3r"}}},"responses":{"201":{"content":{"application/json":{"examples":{"response":{"value":{"created_at":"string","id":"string","owner_email":"string","owner_id":"string"}}},"schema":{"properties":{"created_at":{"description":"Account created date time.","type":"string"},"id":{"description":"Account ID.","type":"string"},"owner_email":{"description":"Account owner email.","type":"string"},"owner_id":{"description":"Account owner ID.","type":"string"}},"type":"object"}},"application/xml":{"schema":{"properties":{"created_at":{"description":"Account created date time.","type":"string"},"id":{"description":"Account ID.","type":"string"},"owner_email":{"description":"Account owner email.","type":"string"},"owner_id":{"description":"Account owner ID.","type":"string"}},"type":"object"}}},"description":"Account created.","headers":{"Content-Location":{"description":"Location of the created account.","schema":{"type":"string"}}}},"400":{"description":"**HTTP Status Code:** `400` \n**Error Code:**`300` Your request could not be completed because the name contains an invalid word: {name}\n**Error Code:** `1107` \nEmail domain is blocked. \n**Error Code:** `1111` \nPassword should not contain repeated characters such as 'aaaaaa'. \nPassword should not contain consecutive characters such as 'abc','123'.\n\n"},"409":{"description":"**HTTP Status Code:** `409` \n**Error Code:** `1005` \nEmail $email has already been used."}},"summary":"Create a sub account","tags":["Accounts"]}},"/accounts/{accountId}":{"delete":{"description":"Disassociate a sub account from its master account. This will leave the sub account intact but it will no longer be associated with the master account. \n\n**Prerequisites:**\n* Pro or a higher paid account with master account option enabled. \n* The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis). \n\n\n**Scope**: `account:write:admin` \n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n\n ","operationId":"accountDisassociate","parameters":[{"description":"The account ID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"**HTTP Status Code**: `204` Account deleted."},"404":{"description":"**HTTP Status Code**: `404` \n**Error Code:** `2000` You cannot disassociate a paid account. \n**Error Code:** `2001` Account does not exist: $subAccountId."}},"summary":"Disassociate a sub account","tags":["Accounts"]},"get":{"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' 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.\n\n**Prerequisites:**\n* Pro or a higher paid account with master account option enabled. \n\n**Scope**: `account:write:admin` \n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n\n \n","operationId":"account","parameters":[{"description":"The account ID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"created_at":"string [date-time]","id":"string","options":{"meeting_connectors":"string","pay_mode":"string","room_connectors":"string","share_mc":"boolean","share_rc":"boolean"},"owner_email":"string","owner_id":"string"}}},"schema":{"properties":{"created_at":{"description":"Account creation date and time.","format":"date-time","type":"string"},"id":{"description":"Account ID.","type":"string"},"options":{"description":"Account options object.","properties":{"billing_auto_renew":{"description":"Toggle whether automatic billing renewal is on or off.","type":"boolean"},"meeting_connector_list":{"description":"Specify the IP addresses of the Meeting Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Meeting Connectors of a master account will be shared with the sub account.\n\n\n**Note:** This option can only be used if the value of `share_mc` is set to `true`.","items":{"type":"string"},"type":"array"},"pay_mode":{"default":"master","description":"Payee: `master` - master account holder pays. `sub` - Sub account holder pays.","enum":["master","sub"],"type":"string","x-enum-descriptions":["master account holder pays","Sub account holder pays"]},"room_connector_list":{"description":"Specify the IP addresses of the Room Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Room Connectors of a master account will be shared with the sub account.\n\n\n**Note:** This option can only be used if the value of `share_rc` is set to `true`.","items":{"type":"string"},"type":"array"},"share_mc":{"default":false,"description":"Enable/disable the option for a sub account to use shared [Meeting Connector(s)](https://support.zoom.us/hc/en-us/articles/201363093-Getting-Started-with-the-Meeting-Connector) that are set up by the master account. Meeting Connectors can only be used by On-prem users.","type":"boolean"},"share_rc":{"default":false,"description":"Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.","type":"boolean"}},"type":"object"},"owner_email":{"description":"Account owner email.","type":"string"},"owner_id":{"description":"Account owner ID.","type":"string"},"vanity_url":{"description":"Account Vanity URL","type":"string"}},"type":"object"}},"application/xml":{"schema":{"properties":{"created_at":{"description":"Account creation date and time.","format":"date-time","type":"string"},"id":{"description":"Account ID.","type":"string"},"options":{"description":"Account options object.","properties":{"billing_auto_renew":{"description":"Toggle whether automatic billing renewal is on or off.","type":"boolean"},"meeting_connector_list":{"description":"Specify the IP addresses of the Meeting Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Meeting Connectors of a master account will be shared with the sub account.\n\n\n**Note:** This option can only be used if the value of `share_mc` is set to `true`.","items":{"type":"string"},"type":"array"},"pay_mode":{"default":"master","description":"Payee: `master` - master account holder pays. `sub` - Sub account holder pays.","enum":["master","sub"],"type":"string","x-enum-descriptions":["master account holder pays","Sub account holder pays"]},"room_connector_list":{"description":"Specify the IP addresses of the Room Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Room Connectors of a master account will be shared with the sub account.\n\n\n**Note:** This option can only be used if the value of `share_rc` is set to `true`.","items":{"type":"string"},"type":"array"},"share_mc":{"default":false,"description":"Enable/disable the option for a sub account to use shared [Meeting Connector(s)](https://support.zoom.us/hc/en-us/articles/201363093-Getting-Started-with-the-Meeting-Connector) that are set up by the master account. Meeting Connectors can only be used by On-prem users.","type":"boolean"},"share_rc":{"default":false,"description":"Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.","type":"boolean"}},"type":"object"},"owner_email":{"description":"Account owner email.","type":"string"},"owner_id":{"description":"Account owner ID.","type":"string"},"vanity_url":{"description":"Account Vanity URL","type":"string"}},"type":"object"}}},"description":"**HTTP Status Code**: `200` \nAccount object returned."},"404":{"description":"**HTTP Status Code**: `404` \n**Error Code:** `2001` Account does not exist: $subAccountId."}},"summary":"Get sub account details","tags":["Accounts"]}},"/accounts/{accountId}/billing":{"get":{"description":"Get [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a sub account. Only master accounts can use this API. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts' billing information. Email the partner programs team at **partner-success@zoom.us** for more details. \n\n**Prerequisites:**\n* Pro or a higher paid account with master account option enabled. \n\n**Scope**:`billing:master` \n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \n\n","operationId":"accountBilling","parameters":[{"description":"The account ID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"address":"string","apt":"string","city":"string","country":"string","email":"string","first_name":"string","last_name":"string","phone_number":"string","state":"string","zip":"string"}}},"schema":{"description":"Billing Contact object.","properties":{"address":{"description":"Billing Contact's address.","type":"string"},"apt":{"description":"Billing Contact's apartment/suite.","type":"string"},"city":{"description":"Billing Contact's city.","type":"string"},"country":{"description":"Billing Contact's Country [ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) in abbreviated format.","type":"string"},"email":{"description":"Billing Contact's email address.","type":"string"},"first_name":{"description":"Billing Contact's first name.","type":"string"},"last_name":{"description":"Billing Contact's last name.","type":"string"},"phone_number":{"description":"Billing Contact's phone number.","type":"string"},"state":{"description":"Billing Contact's state.","type":"string"},"zip":{"description":"Billing Contact's zip/postal code.","type":"string"}},"required":["first_name","last_name","email","phone_number","address","city","state","zip","country"],"type":"object"}},"application/xml":{"schema":{"description":"Billing Contact object.","properties":{"address":{"description":"Billing Contact's address.","type":"string"},"apt":{"description":"Billing Contact's apartment/suite.","type":"string"},"city":{"description":"Billing Contact's city.","type":"string"},"country":{"description":"Billing Contact's Country [ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) in abbreviated format.","type":"string"},"email":{"description":"Billing Contact's email address.","type":"string"},"first_name":{"description":"Billing Contact's first name.","type":"string"},"last_name":{"description":"Billing Contact's last name.","type":"string"},"phone_number":{"description":"Billing Contact's phone number.","type":"string"},"state":{"description":"Billing Contact's state.","type":"string"},"zip":{"description":"Billing Contact's zip/postal code.","type":"string"}},"required":["first_name","last_name","email","phone_number","address","city","state","zip","country"],"type":"object"}}},"description":"**HTTP Status Code:** `200` \nAccount billing contact information returned."},"400":{"description":"**HTTP Status Code:** `400` \n**Error Code:** `2100` \nThis sub account is on self pay mode."},"404":{"description":"**HTTP Status Code:** `404` \n**Error Code:** `2001` \nAccount does not exist: {subAccountId}.\n\n\n"}},"summary":"Get billing information","tags":["Billing"]},"patch":{"description":"Update [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a sub account. \nThis API can only be used by master accounts that pay all billiing charges of their associated sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts' billing information. Email the partner programs team at **partner-success@zoom.us** for more details. \n\n**Prerequisites:**\n* Pro or a higher paid account with master account option enabled. \n\n**Scope**:`billing:master` \n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \n\n","operationId":"accountBillingUpdate","parameters":[{"description":"The account ID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Billing Contact object.","properties":{"address":{"description":"Billing Contact's address.","type":"string"},"apt":{"description":"Billing Contact's apartment/suite.","type":"string"},"city":{"description":"Billing Contact's city.","type":"string"},"country":{"description":"Billing Contact's country.","type":"string"},"email":{"description":"Billing Contact's email address.","type":"string"},"first_name":{"description":"Billing Contact's first name.","type":"string"},"last_name":{"description":"Billing Contact's last name.","type":"string"},"phone_number":{"description":"Billing Contact's phone number.","type":"string"},"state":{"description":"Billing Contact's state.","type":"string"},"zip":{"description":"Billing Contact's zip/postal code.","type":"string"}},"type":"object"}},"multipart/form-data":{"schema":{"description":"Billing Contact object.","properties":{"address":{"description":"Billing Contact's address.","type":"string"},"apt":{"description":"Billing Contact's apartment/suite.","type":"string"},"city":{"description":"Billing Contact's city.","type":"string"},"country":{"description":"Billing Contact's country.","type":"string"},"email":{"description":"Billing Contact's email address.","type":"string"},"first_name":{"description":"Billing Contact's first name.","type":"string"},"last_name":{"description":"Billing Contact's last name.","type":"string"},"phone_number":{"description":"Billing Contact's phone number.","type":"string"},"state":{"description":"Billing Contact's state.","type":"string"},"zip":{"description":"Billing Contact's zip/postal code.","type":"string"}},"type":"object"}}},"required":true,"x-examples":{"application/json":{"address":"string","apt":"string","city":"string","country":"string","email":"string","first_name":"string","last_name":"string","phone_number":"string","state":"string","zip":"string"}}},"responses":{"200":{"description":"**Error Code:** `200` \nPlease subscribe a plan for this sub account first."},"204":{"description":"**HTTP Status Code:** `204` \nAccount billing contact information updated."},"400":{"description":"**HTTP Status Code:** `400` \n**Error Code:** `2100` \nThis sub account is on self pay mode. \nInvalid country parameter: {country}. \nInvalid state parameter: {state}."},"404":{"description":"**HTTP Status Code:** `404` \n**Error Code:** `2001` \nAccount does not exist: {subAccountId}.\n\n\n\n"}},"summary":"Update billing information","tags":["Billing"]}},"/accounts/{accountId}/billing/invoices":{"get":{"description":"List [invoices](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e) of a Zoom account.\n\nTo list a regular Zoom account's invoices or a master account's invoices, provide `me` as the value of the `accountId` path parameter. To list a sub account's invoices, provide the account ID of the sub account in the `accountId` path parameter. \n\n**Prerequisites:**\n* Account must be enrolled in Pro or a higher plan. \n\n**Scope**:`billing:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \n**Additional Rate Limit:** You can make **one** API request per account(`accountId`) every **five** minutes until the daily limit is reached. This API has a daily limit of **6** requests per account(`accountId`).","operationId":"accountBillingInvoices","parameters":[{"description":"Start date for the invoice query in `yyyy-mm-dd` format. The date range defined by the “from” and “to” parameters should not exceed one year. The range defined should fall within the past three years.\n","in":"query","name":"from","schema":{"format":"date","type":"string"}},{"description":"End date for the invoice query in `yyyy-mm-dd` format","in":"query","name":"to","schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"currency":"USD","invoices":[{"balance":2039,"due_date":"2025-08-15T13:53:10.944Z","id":"2c92c12348d07e0580","invoice_date":"2025-08-15T13:53:10.944Z","invoice_number":"S8INsdf4534000001","status":"Draft","target_date":"2025-08-15T13:53:10.944Z","tax_amount":0,"total_amount":2039}]}}},"schema":{"properties":{"currency":{"description":"Currency used in the invoice.","type":"string"},"invoices":{"items":{"properties":{"balance":{"description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n\n","format":"double","type":"number"},"due_date":{"description":"The date by which the payment for this invoice is due.\n\n","type":"string"},"id":{"description":"Unique identifier of the invoice.","type":"string"},"invoice_date":{"description":"The date when the invoice was generated.\n","type":"string"},"invoice_number":{"description":"Invoice number.","type":"string"},"status":{"default":"\"Draft\"","description":"Status of the invoice.","type":"string"},"target_date":{"description":"This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in the invoice.\n","type":"string"},"tax_amount":{"description":"Tax amount.","format":"double","type":"number"},"total_amount":{"description":"Total invoice amount.","format":"double","type":"number"}},"type":"object"},"type":"array"}},"type":"object"}},"application/xml":{"schema":{"properties":{"currency":{"description":"Currency used in the invoice.","type":"string"},"invoices":{"items":{"properties":{"balance":{"description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n\n","format":"double","type":"number"},"due_date":{"description":"The date by which the payment for this invoice is due.\n\n","type":"string"},"id":{"description":"Unique identifier of the invoice.","type":"string"},"invoice_date":{"description":"The date when the invoice was generated.\n","type":"string"},"invoice_number":{"description":"Invoice number.","type":"string"},"status":{"default":"\"Draft\"","description":"Status of the invoice.","type":"string"},"target_date":{"description":"This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in the invoice.\n","type":"string"},"tax_amount":{"description":"Tax amount.","format":"double","type":"number"},"total_amount":{"description":"Total invoice amount.","format":"double","type":"number"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"**HTTP Status Code:** `200` \nAccount billing invoice information returned."},"400":{"description":"**HTTP Status Code:** `400` \n**Error Code:** `200` \nOnly available for Paid account: {subAccountId}.\n**Error Code:** `2001` \nAccount does not exist: {subAccountId}."}},"summary":"List billing invoices","tags":["Billing"]},"parameters":[{"description":"The account ID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}]},"/accounts/{accountId}/billing/invoices/{invoiceId}":{"get":{"description":"Get detailed information about a specific [invoice](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e). To retrieve a regular Zoom account's invoice details or a master account's invoice details, provide `me` as the value of `accountId` path parameter. To list a sub account's invoice details, provide the account ID of the sub account in the `accountId` path parameter. \n\n**Prerequisites:**\n* Account must be enrolled in Pro or a higher plan. \n\n**Scope**:`billing:master` \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \n**Additional Rate Limit:** You can make **one** API request every **thirty** minutes until the daily limit is reached. This API has a daily limit of **100** requests per **account**.","operationId":"getAccountBillingInvoice","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"balance":2039,"currency":"USD","due_date":"2025-08-15T13:53:10.944Z","id":"2c92fghvb0580","invoice_date":"2025-08-15T13:53:10.944Z","invoice_items":[{"charge_name":"Standard Biz Annual","charge_number":"C-00000004","charge_type":"Recurring","end_date":"2025-08-15T13:53:10.944Z","quantity":10,"start_date":"2025-08-15T13:53:10.944Z","tax_amount":0,"total_amount":1999},{"charge_name":"Cloud Recording 100 GB","charge_number":"C-00000005","charge_type":"Recurring","end_date":"2025-08-15T13:53:10.944Z","quantity":1,"start_date":"2025-08-15T13:53:10.944Z","tax_amount":0,"total_amount":40}],"invoice_number":"Shjmr5INV00000001","status":"Draft","target_date":"2025-08-15T13:53:10.944Z","tax_amount":0,"total_amount":2039}}},"schema":{"properties":{"balance":{"description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n\n","format":"double","type":"number"},"currency":{"description":"Billing currency.","type":"string"},"due_date":{"description":"The date by which the payment for this invoice is due.\n\n","type":"string"},"id":{"description":"Unique identifier of the invoice.","type":"string"},"invoice_date":{"description":"The date when the invoice was generated.\n","type":"string"},"invoice_items":{"items":{"properties":{"charge_name":{"description":"Description for the charge.","type":"string"},"charge_number":{"description":"Identifier for the charge.","type":"string"},"charge_type":{"description":"Charge type.","type":"string"},"end_date":{"description":"Billing end date.","format":"date","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"start_date":{"description":"Billing start date.","format":"date","type":"string"},"tax_amount":{"description":"Tax amount.","format":"double","type":"number"},"total_amount":{"description":"Total amount.","format":"double","type":"number"}},"type":"object"},"type":"array"},"invoice_number":{"description":"Invoice number.","type":"string"},"status":{"default":"\"Draft\"","description":"Status of the invoice.","type":"string"},"target_date":{"description":"This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in the invoice.\n","type":"string"},"tax_amount":{"description":"Tax amount.","format":"double","type":"number"},"total_amount":{"description":"Total invoice amount.","format":"double","type":"number"}},"type":"object"}},"application/xml":{"schema":{"properties":{"balance":{"description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n\n","format":"double","type":"number"},"currency":{"description":"Billing currency.","type":"string"},"due_date":{"description":"The date by which the payment for this invoice is due.\n\n","type":"string"},"id":{"description":"Unique identifier of the invoice.","type":"string"},"invoice_date":{"description":"The date when the invoice was generated.\n","type":"string"},"invoice_items":{"items":{"properties":{"charge_name":{"description":"Description for the charge.","type":"string"},"charge_number":{"description":"Identifier for the charge.","type":"string"},"charge_type":{"description":"Charge type.","type":"string"},"end_date":{"description":"Billing end date.","format":"date","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"start_date":{"description":"Billing start date.","format":"date","type":"string"},"tax_amount":{"description":"Tax amount.","format":"double","type":"number"},"total_amount":{"description":"Total amount.","format":"double","type":"number"}},"type":"object"},"type":"array"},"invoice_number":{"description":"Invoice number.","type":"string"},"status":{"default":"\"Draft\"","description":"Status of the invoice.","type":"string"},"target_date":{"description":"This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in the invoice.\n","type":"string"},"tax_amount":{"description":"Tax amount.","format":"double","type":"number"},"total_amount":{"description":"Total invoice amount.","format":"double","type":"number"}},"type":"object"}}},"description":"**HTTP Status Code:** `200` \nAccount billing invoice information returned."},"400":{"description":"**HTTP Status Code:** `400` \n**Error Code:** `2001` \nAccount does not exist: {subAccountId}. \nInvoiceId does not exist: {invoiceId}."}},"summary":"Get invoice details","tags":["Billing"]},"parameters":[{"description":"The account ID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The invoice ID.","in":"path","name":"invoiceId","required":true,"schema":{"type":"string"}}]},"/accounts/{accountId}/lock_settings":{"get":{"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.\nUse this API to retrieve an account's locked settings. \n\n**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. \n**Prerequisites:**\n* Pro or a higher paid account. \n\n**Scope**: `account:read:admin`.\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \n\n\n\n\n\n**Scope:** account:read:admin","operationId":"getAccountLockSettings","parameters":[{"description":"Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide \"me\" as the value of this field. To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"`meeting_security`: Use this query parameter to view meeting security settings applied on the account. ","in":"query","name":"option","schema":{"type":"string"}},{"description":"Provide the name of the field by which you would like to filter the response. For example, if you provide \"host_video\" as the value of this field, you will get a response similar to the following: \n{\n \"schedule_meeting\": {\n \"host_video\": false\n }\n}\n You can provide multiple values by separating them with commas(example: \"host_video,participant_video”).","in":"query","name":"custom_query_fields","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"email_notification":{"properties":{"alternative_host_reminder":{"description":"Notify the alternative host who is set or removed.","type":"boolean"},"cancel_meeting_reminder":{"description":"Notify host and participants when the meeting is cancelled.","type":"boolean"},"cloud_recording_available_reminder":{"description":"Notify host when cloud recording is available.","type":"boolean"},"jbh_reminder":{"description":"Notify host when participants join the meeting before them.","type":"boolean"},"schedule_for_host_reminder":{"description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","type":"boolean"}},"type":"object"},"in_meeting":{"properties":{"alert_guest_join":{"description":"Allow participants who belong to your account to see that a guest (someone who does not belong to your account) is participating in the meeting/webinar.","type":"boolean"},"allow_show_zoom_windows":{"description":"Show Zoom windows during screen share.","type":"boolean"},"annotation":{"description":"Allow participants to use annotation tools to add information to shared screens.","type":"boolean"},"anonymous_question_answer":{"description":"","type":"boolean"},"attendee_on_hold":{"default":false,"description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","type":"boolean"},"auto_answer":{"description":"Enable users to see and add contacts to 'auto-answer group' in the contact list on chat. Any call from members of this group will be automatically answered.","type":"boolean"},"auto_saving_chat":{"description":"Automatically save all in-meeting chats.","type":"boolean"},"breakout_room":{"description":"Allow host to split meeting participants into separate, smaller rooms.","type":"boolean"},"chat":{"description":"Allow meeting participants to send chat message visible to all participants.","type":"boolean"},"closed_caption":{"description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","type":"boolean"},"co_host":{"description":"Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.","type":"boolean"},"custom_data_center_regions":{"description":"Displays whether or not custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) have been selected for meetings/webinars hosted by the account.","type":"boolean"},"dscp_marking":{"description":"Enable DSCP marking for signaling and media packets. (Default is 56 for audio, 40 for video, and 40 for signaling.) ","type":"boolean"},"e2e_encryption":{"description":"Require that all meetings are encrypted using AES.","type":"boolean"},"entry_exit_chime":{"description":"Play sound when participants join or leave.","type":"string"},"far_end_camera_control":{"description":"Allow another user to take control of the camera during a meeting.","type":"boolean"},"feedback":{"description":"Enable users to provide feedback to Zoom at the end of the meeting.","type":"boolean"},"file_transfer":{"description":"Indicates whether [in-meeting file transfer](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting has been enabled for all users on the account or not.","type":"boolean"},"group_hd":{"description":"Enable higher quality video for host and participants. This will require more bandwidth.","type":"boolean"},"original_audio":{"description":"Allow users to select original sound during a meeting.","type":"boolean"},"polling":{"description":"Add 'Polls' to the meeting controls. This allows the host to survey the attendees.","type":"boolean"},"post_meeting_feedback":{"description":"Display end-of-meeting experience feedback survey.","type":"boolean"},"private_chat":{"description":"Allow meeting participants to send a private 1:1 message to another participant.","type":"boolean"},"remote_control":{"description":"During screen sharing, allow the person who is sharing to let others control the shared content.","type":"boolean"},"request_permission_to_unmute":{"description":"Indicates whether the [**Request permission to unmute participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting#h_01EGK4XFWS1SJGZ71MYGKF7260) option is enabled and locked for the account or not.","type":"boolean"},"screen_sharing":{"description":"Allow host and participants to share their screen or content during meetings.","type":"boolean"},"sending_default_email_invites":{"description":"Allow users to invite participants by email only by default.","type":"boolean"},"show_meeting_control_toolbar":{"description":"Always show meeting controls during a meeting.","type":"boolean"},