Zoom Rooms API
Number of APIs: 64
1. workspaces-{workspaceId}-reservations-{reservationId} - Delete a reservation
DELETE {{baseUrl}}/workspaces/:workspaceId/reservations/:reservationId
2. workspaces-{workspaceId}-reservations-{reservationId} - Update a reservation
PATCH {{baseUrl}}/workspaces/:workspaceId/reservations/:reservationId
Use this API to update a reservation.
Scopes: workspace:writeworkspace:write:admin
Rate Limit Label: Medium
3. workspaces-{workspaceId}-reservations - Get a workspace's reservations
GET {{baseUrl}}/workspaces/:workspaceId/reservations?from=<dateTime>&to=<dateTime>&user_id=<string>
Use this API to get a workspace's reservations.
Scopes: workspace:readworkspace:read:admin
Rate Limit Label: Medium
4. workspaces-{workspaceId}-reservations - Create a reservation
POST {{baseUrl}}/workspaces/:workspaceId/reservations
Use this API to create a workspace reservation.
Scopes: workspace:writeworkspace:write:admin
Rate Limit Label: Medium
5. workspaces-{workspaceId}-qr_code - Get a workspace QR code
GET {{baseUrl}}/workspaces/:workspaceId/qr_code
6. workspaces-{workspaceId} - Get a workspace
GET {{baseUrl}}/workspaces/:workspaceId
7. workspaces-{workspaceId} - Delete a workspace
DELETE {{baseUrl}}/workspaces/:workspaceId
8. workspaces-{workspaceId} - Update a workspace
PATCH {{baseUrl}}/workspaces/:workspaceId
9. workspaces-usage - Get a location's hot desk usage
GET {{baseUrl}}/workspaces/usage?location_id=<string>
Use this API to get a location's hot desk usage information.
Scopes: workspace:readworkspace:read:admin
Rate Limit Label: Medium
10. workspaces-events - Check in/out of a reservation
POST {{baseUrl}}/workspaces/events
Use this API to check in to or out of a reservation.
Scopes: workspace:writeworkspace:write:admin
Rate Limit Label: Medium
11. workspaces - List workspaces
GET {{baseUrl}}/workspaces?location_id=<string>&page_size=30&next_page_token=<string>
Use this API to list a location's workspaces.
Scopes: workspace:readworkspace:read:admin
Rate Limit Label: MEDIUM
12. workspaces - Create a workspace
POST {{baseUrl}}/workspaces
13. rooms-{roomId}-tags - Un-assign Tags from a Zoom Room
DELETE {{baseUrl}}/rooms/:roomId/tags?tag_ids=<string>
Use this API to un-assign Tags from a Zoom Room
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:write:admin
Rate Limit Label: Medium
14. rooms-{roomId}-tags - Assign Tags to a Zoom Room
PATCH {{baseUrl}}/rooms/:roomId/tags
Use this API to assign Tags to a Zoom Room
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:write:admin
Rate Limit Label: MEDIUM
15. rooms-{roomId}-sensor_data - Get Zoom Room sensor data
GET {{baseUrl}}/rooms/:roomId/sensor_data?from=<string>&to=<string>&page_size=30&next_page_token=<string>&device_id=<string>&sensor_type=CO2
Use this API to get the sensor data from the specified Zoom Room.
Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
Scopes: room:read:admin
Rate Limit Label: Medium
16. rooms-{roomId}-location - Change a Zoom Room's location
PUT {{baseUrl}}/rooms/:roomId/location
An account owner of a Zoom account can establish a Zoom Rooms Location Hierarchy to better organize Zoom Rooms spread across various locations. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. Use this API to assign a new location for a Zoom Room. Note that the Zoom Room can be assigned only to the lowest level location available in the hierarchy. Prerequisite:
- Account owner or admin permission
- Zoom Rooms version 4.0 or higher
Scopes: room:write:admin
Rate Limit Label: Light
17. rooms-{roomId}-devices-{deviceId}-app_version - Change Zoom Rooms app version
PUT {{baseUrl}}/rooms/:roomId/devices/:deviceId/app_version
Use this API to upgrade or downgrade the version of your installed Zoom Rooms app on your Mac or Windows device.
Prerequisites: * A Pro or a higher account with Zoom Rooms. * The Zoom Rooms software must be installed on a Mac or a Windows device. This API does not support other devices.
Scopes: room:write:admin
Rate Limit Label: Medium
18. rooms-{roomId}-devices-{deviceId} - Delete a Zoom Room user device
DELETE {{baseUrl}}/rooms/:roomId/devices/:deviceId
Use this API to delete a Zoom Room device.
Prerequisites:
Pro or a higher plan with Zoom Room license.
Account owner or admin permissions.
Scopes: room:write:admin
Rate Limit Label: Medium
19. rooms-{roomId}-devices - List Zoom Room devices
GET {{baseUrl}}/rooms/:roomId/devices
List information about the devices that are being used for a specific Zoom Room in an account.
Prerequisites:
Pro or a higher plan with Zoom Room license.
Account owner or admin permissions.
Scopes: room:read:admin
Rate Limit Label: Medium
20. rooms-{roomId}-device_profiles-{deviceProfileId} - Get a device profile
GET {{baseUrl}}/rooms/:roomId/device_profiles/:deviceProfileId
Use this API to return a Zoom Room device profile.
Prerequisites: * A Pro or a higher account with Zoom Rooms.
Scopes: room:read:admin
Rate Limit Label: Medium
21. rooms-{roomId}-device_profiles-{deviceProfileId} - Delete a device profile
DELETE {{baseUrl}}/rooms/:roomId/device_profiles/:deviceProfileId
Use this API to delete a Zoom Room device profile.
Prerequisites: * A Pro or a higher account with Zoom Rooms.
Scopes: room:write:admin
Rate Limit Label: Medium
22. rooms-{roomId}-device_profiles-{deviceProfileId} - Update a device profile
PATCH {{baseUrl}}/rooms/:roomId/device_profiles/:deviceProfileId
Use this API to update a Zoom Room device profile.
Prerequisites: * A Pro or a higher account with Zoom Rooms.
Scopes: room:write:admin
Rate Limit Label: Medium
23. rooms-{roomId}-device_profiles-devices - Get device information
GET {{baseUrl}}/rooms/:roomId/device_profiles/devices
Use this API to return information about a Zoom Room device.
Prerequisites: * A Pro or a higher account with Zoom Rooms.
Scopes: room:read:admin
Rate Limit Label: Medium
24. rooms-{roomId}-device_profiles - List device profiles
GET {{baseUrl}}/rooms/:roomId/device_profiles
Use this API to return a list of Zoom Room device profiles.
Prerequisites: * A Pro or a higher account with Zoom Rooms.
Scopes: room:read:admin
Rate Limit Label: Medium
25. rooms-{roomId}-device_profiles - Create a device profile
POST {{baseUrl}}/rooms/:roomId/device_profiles
Use this API to create a Zoom Room device profile.
Prerequisites: * A Pro or a higher account with Zoom Rooms.
Scopes: room:write:admin
Rate Limit Label: Medium
26. rooms-{roomId} - Get Zoom Room profile
GET {{baseUrl}}/rooms/:roomId?regenerate_activation_code=false
Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to get detailed information on a specific Zoom Room in a Zoom account.
Prerequisites:
- Pro or a higher plan with Zoom Room license.
Scopes: room:read:admin
Rate Limit Label: MEDIUM
27. rooms-{roomId} - Delete a Zoom Room
DELETE {{baseUrl}}/rooms/:roomId
Remove a specific Zoom Room profile from a Zoom account.
Prerequisites:
- Pro or a higher plan with Zoom Room license.
Scopes: room:write:admin
Rate Limit Label: Light
28. rooms-{roomId} - Update a Zoom Room profile
PATCH {{baseUrl}}/rooms/:roomId
Update basic information on a specific Zoom Room in a Zoom account.
Prerequisites:
- Pro or a higher plan with Zoom Room license.
Scopes: room:write:admin
Rate Limit Label: Medium
29. rooms-{id}-settings - Get Zoom Room settings
GET {{baseUrl}}/rooms/:id/settings?setting_type=meeting
Get information on meeting or alert settings applied to a specific Zoom Room. By default, only Meeting Settings are returned. To view only Alert Settings, specify alert as the value of the setting_type query parameter.
Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
Scopes: room:read:admin
Rate Limit Label: MEDIUM
30. rooms-{id}-settings - Update Zoom Room settings
PATCH {{baseUrl}}/rooms/:id/settings?setting_type=<string>
Update either meeting or alert settings applied to a specific Zoom Room. To update Alert Settings, specify alert as the value of the setting_type query parameter. To update Meeting Settings, specify meeting as the value of the setting_type query parameter.
Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
Scopes: room:write:admin
Rate Limit Label: MEDIUM
31. rooms-{id}-location - Change a Zoom Room's location
PUT {{baseUrl}}/rooms/:id/location
An account owner of a Zoom account can establish a Zoom Rooms Location Hierarchy to better organize Zoom Rooms spread across various locations. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. Use this API to assign a new location for a Zoom Room. Note that the Zoom Room can be assigned only to the lowest level location available in the hierarchy. Prerequisite:
- Account owner or admin permission
- Zoom Rooms version 4.0 or higher
Scopes:
Rate Limit Label: Light
32. rooms-{id}-events - Use Zoom Room controls
PATCH {{baseUrl}}/rooms/:id/events
Use this API to control Zoom Rooms, including room check-in and check-out, mute on and off, incoming meeting request accept or decline, meeting join, leave, or end, room restart, and cancellation.
Prerequisites: * Zoom Rooms must have been set up for use for the account and must be online. * You must have access to the Calendar Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information associated with the Room.
Scopes: room:write:admin
Rate Limit Label: Medium
33. rooms-{id}-devices-{deviceId}-app_version - Change Zoom Rooms app version
PUT {{baseUrl}}/rooms/:id/devices/:deviceId/app_version
Use this API to upgrade or downgrade the version of your installed Zoom Rooms app on your Mac or Windows device.
Prerequisites: * A Pro or a higher account with Zoom Rooms. * The Zoom Rooms software must be installed on a Mac or a Windows device. This API does not support other devices.
Scopes:
Rate Limit Label: Medium
34. rooms-{id}-devices - List Zoom Room devices
GET {{baseUrl}}/rooms/:id/devices
List information about the devices that are being used for a specific Zoom Room in an account.
Prerequisites:
Pro or a higher plan with Zoom Room license.
Account owner or admin permissions.
Scopes:
Rate Limit Label: Medium
35. rooms-{id} - Delete a Zoom Room
DELETE {{baseUrl}}/rooms/:id
Remove a specific Zoom Room profile from a Zoom account.
Prerequisites:
- Pro or a higher plan with Zoom Room license.
Scopes:
Rate Limit Label: Light
36. rooms-tags-{tagId} - Delete Tag
DELETE {{baseUrl}}/rooms/tags/:tagId
Use this API to delete Tag.
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:write:admin
Rate Limit Label: Medium
37. rooms-tags-{tagId} - Edit Tag
PATCH {{baseUrl}}/rooms/tags/:tagId
Use this API to edit Tag.
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:write:admin
Rate Limit Label: Medium
38. rooms-tags - List all Zoom Room Tags
GET {{baseUrl}}/rooms/tags?page_size=30&next_page_token=<string>
Use this API to list all Zoom Rooms Tags
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:read:admin
Rate Limit Label: Medium
39. rooms-tags - Create a new Zoom Rooms Tag
POST {{baseUrl}}/rooms/tags
Use this API to create a new Zoom Rooms Tag.
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:write:admin
Rate Limit Label: Medium
40. rooms-locations-{locationId}-tags - Assign Tags to Zoom Rooms By Location ID
PATCH {{baseUrl}}/rooms/locations/:locationId/tags
Use this API to assign Tags to Zoom Rooms by location ID Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:write:admin
Rate Limit Label: MEDIUM
41. rooms-locations-{locationId}-settings - Get location settings
GET {{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting
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.
Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
Scopes: room:read:admin
Rate Limit Label: MEDIUM
42. rooms-locations-{locationId}-settings - Update location settings
PATCH {{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting
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.
Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
Scopes: room:write:admin
Rate Limit Label: MEDIUM
43. rooms-locations-{locationId}-location - Change the assigned parent location
PUT {{baseUrl}}/rooms/locations/:locationId/location
An account owner of a Zoom account can establish a Zoom Rooms Location Hierarchy to better organize Zoom Rooms spread across various locations. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. The location in the lower level in the hierarchy is considered as a child of the location that is a level above in the hierarchy. Use this API to change the parent location of a child location.
For instance, if the location hierarchy is structured in a way where there are two campuses (Campus 1, and Campus 2) in a City and Campus 1 consists of a building named Building 1 with a floor where Zoom Rooms are located, and you would like to rearrange the structure so that Building 1 along with its child locations (floor and Zoom Rooms) are relocated directly under Campus 2 instead of Campus 1, you must provide the location ID of Building 1 in the path parameter of this request and the location ID of Campus 2 as the value of parent_location_id in the request body.
Prerequisite:
- Account owner or admin permission
- Zoom Rooms version 4.0 or higher
Scopes: room:write:admin
Rate Limit Label: Medium
44. rooms-locations-{locationId} - Get Zoom Room location profile
GET {{baseUrl}}/rooms/locations/:locationId
Each location type of the Zoom Rooms location hierarchy has a profile page with information such as the location name, address, support email, and more. Use this API to retrieve information about a specific Zoom Rooms location type, such as the city location of the Zoom Rooms.
Prerequisite:
- Account owner or admin permission
- Zoom Rooms version 4.0 or higher
Scopes: room:read:admin
Rate Limit Label: MEDIUM
45. rooms-locations-{locationId} - Update Zoom Room location profile
PATCH {{baseUrl}}/rooms/locations/:locationId
Each location type of the Zoom Rooms location hierarchy has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located.
Prerequisite:
- Account owner or admin permission
- Zoom Rooms version 4.0 or higher
Scopes: room:write:admin
Rate Limit Label: Medium
46. rooms-locations-structure - Get Zoom Room location structure
GET {{baseUrl}}/rooms/locations/structure
Get the location hierarchial structure(s) applied on the Zoom Rooms in an account.
Prerequisites:
- Zoom Rooms version 4.0 or higher
- Account owner or admin permissions
Scopes: room:read:admin
Rate Limit Label: Light
47. rooms-locations-structure - Update Zoom Rooms location structure
PUT {{baseUrl}}/rooms/locations/structure
Update the location hierarchial structure(s) applied on the Zoom Rooms in an account.
Prerequisites:
- Zoom Rooms version 4.0 or higher
- Account owner or admin permissions
Scopes: room:write:admin
Rate Limit Label: Medium
48. rooms-locations - List Zoom Room locations
GET {{baseUrl}}/rooms/locations?parent_location_id=<string>&type=<string>&page_size=30&next_page_token=<string>
A Zoom account owner or a Zoom Room administrator can establish a location hierarchy to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account.
Prerequisites: * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher
Scopes: room:read:admin
Rate Limit Label: Medium
49. rooms-locations - Add a location
POST {{baseUrl}}/rooms/locations
Add a location to the location hierarchial structure(s) of Zoom Rooms in an account.
Prerequisites: * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher
Scopes: room:write:admin
Rate Limit Label: Light
50. rooms-events - Update E911 digital signage
PATCH {{baseUrl}}/rooms/events
Display or hide E911 emergency alert text content from Zoom Rooms digital signage.
Prerequisites:
- Zoom Rooms 5.3.0 or higher
- Zoom Rooms digital signage must be enabled
Scopes: room:write:admin
Rate Limit Label: Medium
51. rooms-digital_signage - List digital signage contents
GET {{baseUrl}}/rooms/digital_signage?type=<string>&folder_id=<string>&page_size=30&next_page_token=<string>
Use this API to return information about a Zoom account's Zoom Rooms digital signage content. You can also view this content in the Room Management section's Digital Signage Content tab in the Zoom web portal.
Prerequisites: * A Pro or a higher account with Zoom Rooms. * Existing content in the Digital Signage Content tab.
Scopes: room:read:admin
Rate Limit Label: Medium
52. rooms-calendar-services-{serviceId}-sync - Start calendar service sync process
PUT {{baseUrl}}/rooms/calendar/services/:serviceId/sync
Use this API to kick off the sync process for Zoom Room account's calendar service.
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:write:admin
Rate Limit Label: Medium
53. rooms-calendar-services-{serviceId}-resources-{resourceId} - Get a calendar resource by ID
GET {{baseUrl}}/rooms/calendar/services/:serviceId/resources/:resourceId
Use this API to get a Zoom Room account's calendar resource.
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:read:admin
Rate Limit Label: Medium
54. rooms-calendar-services-{serviceId}-resources-{resourceId} - Delete a calendar resource
DELETE {{baseUrl}}/rooms/calendar/services/:serviceId/resources/:resourceId
Use this API to delete a Zoom Room account's calendar resource from a Microsoft Exchange or Office 365 calendar service.
Note: This API does not support deleting a calendar resource from a Google calendar service.
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:write:admin
Rate Limit Label: Medium
55. rooms-calendar-services-{serviceId}-resources - List calendar resources by calendar service
GET {{baseUrl}}/rooms/calendar/services/:serviceId/resources?page_size=30&next_page_token=<string>
Use this API to list all of a Zoom Room account's calendar resources.
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:read:admin
Rate Limit Label: Medium
56. rooms-calendar-services-{serviceId}-resources - Add a calendar resource to a calendar service
POST {{baseUrl}}/rooms/calendar/services/:serviceId/resources
Use this API to add a calendar resource to a Microsoft Exchange or Office 365 calendar service in a Zoom Room account.
Note: This API does not support adding a calendar resource to a Google calendar service.
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:write:admin
Rate Limit Label: Medium
57. rooms-calendar-services-{serviceId} - Delete a calendar service
DELETE {{baseUrl}}/rooms/calendar/services/:serviceId
Use this API to delete a Zoom Room account's calendar service.
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:write:admin
Rate Limit Label: Medium
58. rooms-calendar-services - List calendar services
GET {{baseUrl}}/rooms/calendar/services
Use this API to list all the existing calendar services in a Zoom Room account.
Prerequisites: * A Pro or a higher plan with a Zoom Rooms license.
Scopes: room:read:admin
Rate Limit Label: Medium
59. rooms-account_settings - Get Zoom Room account settings
GET {{baseUrl}}/rooms/account_settings?setting_type=meeting
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 Notification 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.
Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
Scopes: room:read:admin
Rate Limit Label: Medium
60. rooms-account_settings - Update Zoom Room account settings
PATCH {{baseUrl}}/rooms/account_settings?setting_type=meeting
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 Notification 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.
Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
Scopes: room:write:admin
Rate Limit Label: Medium
61. rooms-account_profile - Get Zoom Room account profile
GET {{baseUrl}}/rooms/account_profile
Get details 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 get information on an individual Room Profile, use the Get Zoom Room profile API.
Prerequisites:
- Zoom account owner or Zoom Rooms admin permissions
Scopes: room:read:admin
Rate Limit Label: Medium
62. rooms-account_profile - Update Zoom Room account profile
PATCH {{baseUrl}}/rooms/account_profile
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 the Update a Zoom Room profile API.
Prerequisites:
- Zoom account owner or Zoom Rooms admin permissions
Scopes: room:write:admin
Rate Limit Label: Medium
GET {{baseUrl}}/rooms?status=UnderConstruction&tag_ids=<string>&type=ZoomRoom&unassigned_rooms=false&page_size=30&next_page_token=<string>&location_id=<string>&query_name=<string>
Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing Zoom Rooms in a Zoom account.
Prerequisites:
- Pro or a higher plan with Zoom Room license.
Scopes: room:read:admin
Rate Limit Label: MEDIUM
POST {{baseUrl}}/rooms
Use this API to add a Zoom Room to a Zoom account.
Prerequisites:
- Pro or a higher plan with Zoom Room license.
Scopes: room:write:admin
Rate Limit Label: Medium
ENDPOINTS