Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
SMS
Provider Exchange
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Deprecated API Endpoints
get

/metrics/zoomrooms/{zoomroomId}

The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room.

Use this API to retrieve information on a specific room.

Scopes: dashboard_zr:read:admin

Rate Limit Label: HeavyPrerequisites:

  • Business, Education or API Plan with Zoom Rooms set up.

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
4 Query Parameters

Responses

HTTP Status Code: 200
Zoom room returned.
Only available for paid accounts that have enabled the Dashboard feature.

1 Example
Schema
object

Zoom room.

id
string

Zoom room ID.

room_name
string

Zoom room name.

calender_name
string

Zoom calendar name.

email
string

Zoom room email.

account_type
string

Zoom room email type.

status
string

Zoom room status.

device_ip
string

Zoom room device IP.

camera
string

Zoom Room camera.

Note: This response returns an empty string (““) value for any users who are not a part of the host’s account (external users).

microphone
string

Zoom Room microphone.

Note: This response returns an empty string (““) value for any users who are not a part of the host’s account (external users).

speaker
string

Zoom Room speaker.

Note: This response returns an empty string (““) value for any users who are not a part of the host’s account (external users).

last_start_time
string

Zoom room last start time.

location
string

Zoom room location.

issues
array[string]

Issues encountered by the Zoom Room.

health
string

Health of the Zoom Room.

live_meeting
object

Meeting metric details.

past_meetings
object

Pagination object.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
zoomroomId
$$.env
1 variable not set
oauth_access_token