Zoom

Links

    Zoom API

    Getting access, Developing, Testing

    Back to Zoom

    List Zoom Rooms

    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:

    Input

    type: object properties: parameters: type: object properties: status: enum: - Offline - Available - InMeeting - UnderConstruction type: string example: Offline description: The status of the Zoom Room. type: enum: - Kiosk - ZoomRoom - StandaloneWhiteboard - SchedulingDisplayOnly - DigitalSignageOnly type: string example: ZoomRoom description: Type of the Zoom Rooms. unassigned_rooms: default: false type: boolean example: true description: >- Use this query parameter with a value of `true` if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet. page_size: default: 30 maximum: 300 type: integer example: 30 description: The number of records returned within a single API call. next_page_token: type: string example: IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2 description: >- Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. location_id: type: string example: 49D7a0xPQvGQ2DCMZgSe7w description: Parent location ID of the Zoom Room. query_name: type: string example: My Zoom Room name description: >- The name of a Zoom Room. If you do not call this parameter, the API will return all of the account's Zoom Rooms. title: Parameters

    Output

    type: 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 example: At6eWnFZ1FB3arCXnRxqHLXKhbDW18yz2i2 page_size: description: The number of records returned within a single API call. type: integer example: 20 rooms: description: List of existing Zoom Rooms. type: array items: type: object properties: activation_code: description: The code used to complete the setup of the Zoom Room. type: string example: 1315-2376-2198-7926 id: description: Unique Identifier of the Zoom Room. type: string example: qMOLddnySIGGVycz8aX_JQ location_id: description: >- Unique Identifier of the [location](/docs/api-reference/zoom-api/methods#operation/listZRLocations) of the room. type: string example: 49D7a0xPQvGQ2DCMZgSe7w name: description: Name of the Zoom Room. type: string example: My Room room_id: description: >- Globally unique identifier of the Zoom Room. Use this ID for the **Dashboard Zoom Room APIs**. type: string example: qMOLddnySIGGVycz8aX_JQ status: description: Status of the Zoom Room. enum: - Offline - Available - InMeeting - UnderConstruction type: string example: Offline