Zoom

Zoom Dashboard API

The Dashboard API from Zoom — 9 operation(s) for dashboard.

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /metrics/crc Get hourly CRC port usage · Dashboard crc #
Ask an LLM
“How busy were our Cloud Room Connector ports hour by hour?”
“Can I see CRC port usage across a date range?”
Tell an agent
Show hourly CRC port usage from {from} to {to}.
Get Cloud Room Connector port utilization between {from} and {to}.
POST /metrics/im Get IM usage statistics · Dashboard im #
Ask an LLM
“How much are people using instant messaging on our account?”
“Can I get chat usage stats for a specific period?”
Tell an agent
Get instant messaging statistics from {from} to {to}.
Show IM usage numbers between {from} and {to}, page {page_number}.
POST /metrics/meetingdetail Get dashboard details for one meeting · Dashboard meetingdetail #
Ask an LLM
“What does the dashboard show for a single live or past meeting?”
“Can I drill into one meeting's details from the metrics dashboard?”
Tell an agent
Get dashboard details for meeting {meeting_id} of type {type}.
Drill into {type} meeting {meeting_id} on the dashboard.
POST /metrics/meetings List live or past meetings in a period · Dashboard meetings #
Ask an LLM
“Which meetings are running right now across the account?”
“Can I list past meetings on the dashboard for a date range?”
Tell an agent
List {type} meetings on the dashboard from {from} to {to}.
Show dashboard meetings of type {type} between {from} and {to}, {page_size} per page.
POST /metrics/qos Get participants' quality of service in a meeting · Dashboard qos #
Ask an LLM
“Why did a meeting have bad audio or video, and whose connection was it?”
“Can I check call quality for one participant in a meeting?”
Tell an agent
Get quality-of-service data for {type} meeting {meeting_id}.
Show QoS for user {user_id} in {type} meeting {meeting_id}.
POST /metrics/webinardetail Get dashboard details for one webinar · Dashboard webinardetail #
Ask an LLM
“What does the dashboard report for a single live or past webinar?”
“Can I see participant details for one webinar in the metrics?”
Tell an agent
Get dashboard details for webinar {meeting_id} of type {type}.
Drill into {type} webinar {meeting_id} on the dashboard.
POST /metrics/webinars List live or past webinars in a period · Dashboard webinars #
Ask an LLM
“Which webinars are live on our account right now?”
“Can I pull the past webinars from the dashboard for last month?”
Tell an agent
List {type} webinars on the dashboard from {from} to {to}.
Show dashboard webinars of type {type} between {from} and {to}, page {page_number}.
POST /metrics/zoomroomdetail Get dashboard details for one Zoom Room · Dashboard zoomroomdetail #
Ask an LLM
“How has one particular Zoom Room been used over a period?”
“Can I see a single room's dashboard info by its ID?”
Tell an agent
Get dashboard details for Zoom Room {id} from {from} to {to}.
Show usage of room {id} between {from} and {to}.
POST /metrics/zoomrooms List all Zoom Rooms · Dashboard zoomrooms #
Ask an LLM
“What Zoom Rooms do we have on the account?”
“Can I page through every conference room on the dashboard?”
Tell an agent
List all Zoom Rooms on the account.
Show page {page_number} of our Zoom Rooms.

Documentation

📖
Documentation
https://developers.zoom.us/docs/api/rest/chat-api/
📖
Documentation
https://developers.zoom.us/docs/api/rest/reference/user/methods/
📖
Documentation
https://developers.zoom.us/docs/api/rest/zoom-phone-api/
📖
Documentation
https://developers.zoom.us/docs/api/
📖
Documentation
https://developers.zoom.us/docs/api/rest/account/
📖
APIReference
https://developers.zoom.us/docs/api/rest/reference/account/methods/
📖
Documentation
https://developers.zoom.us/docs/video-sdk/web/recording/
📖
Documentation
https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/
📖
Documentation
https://developers.zoom.us/docs/api/rest/user/
📖
APIReference
https://developers.zoom.us/docs/api/rest/reference/user/methods/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoom/refs/heads/main/openapi/zoom-dashboard-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zoom-dashboard-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoom-dashboard-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zoom REST Dashboard API
  description: API Description
  contact:
    name: Zoom Developers
    url: https://zoom.us/developer
    email: developer@zoom.us
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.0.0
servers:
- url: https://api.zoom.us/v1
security:
- api_key: []
- api_secret: []
tags:
- name: Dashboard
  description: Dashboard operations
paths:
  /metrics/crc:
    post:
      tags:
      - Dashboard
      description: Get CRC Port usage hour by hour for a specified time period.
      operationId: dashboardCrc
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - from
              - to
              type: object
              properties:
                from:
                  type: string
                  description: Start date.
                to:
                  type: string
                  description: End date.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                from: 2015-03-12
                to: 2015-03-12
                crc_ports_usage:
                - date_time: 2015-03-12
                  crc_ports_hour_usage:
                  - hour: '00'
                    max_usage: 1
                    total_usage: 3
      summary: Dashboard crc
      x-summary-source: derived
  /metrics/im:
    post:
      tags:
      - Dashboard
      description: Get statistics of Zoom IM
      operationId: dashboardIm
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - from
              - to
              type: object
              properties:
                from:
                  type: string
                  description: Start date.
                to:
                  type: string
                  description: End date.
                page_size:
                  type: string
                  description: The amount of records returns within a single API call. Defaults to 30. Max of 30 records.
                  default: '30'
                page_number:
                  type: string
                  description: Current page number of returned records. Default to 1.
                  default: '1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                from: 2016-04-12
                to: 2016-04-13
                page_count: 1
                page_number: 1
                page_size: 30
                total_records: 10
                users:
                - user_id: unique_id
                  user_name: Zoomie Userton
                  email: email_address
                  total_send: 0
                  total_receive: 0
                  group_send: 0
                  group_receive: 0
                  calls_send: 0
                  calls_receive: 0
                  files_send: 0
                  files_receive: 0
                  images_send: 0
                  images_receive: 0
                  voice_send: 0
                  voice_receive: 0
                  videos_send: 0
                  videos_receive: 0
                  emoji_send: 0
                  emoji_receive: 0
      summary: Dashboard im
      x-summary-source: derived
  /metrics/meetingdetail:
    post:
      tags:
      - Dashboard
      description: Get live and past meeting details
      operationId: dashboardMeetingdetail
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - meeting_id
              - type
              type: object
              properties:
                meeting_id:
                  type: string
                  description: 'The meeting ID Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03'
                type:
                  type: string
                  description: Meeting type. 1 means live meeting. 2 means past meeting.
                page_size:
                  type: string
                  description: The amount of records returns within a single API call. Defaults to 30. Max of 100 records.
                  default: '30'
                page_number:
                  type: string
                  description: Current page number of returned records. Default to 1.
                  default: '1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                uuid: unique_id
                id: '123456789'
                type: Past Meeting
                host: Zoomie Userton
                email: email_address
                user_type: Pro
                start_time: 2015-08-30 05:36:56+00:00
                end_time: 2015-08-30 06:36:56+00:00
                duration: 4 mins
                has_pstn: false
                has_voip: true
                has_3rd_party_audio: false
                has_video: true
                has_screen_share: false
                recording: 0
                participants_count: 2
                page_count: 1
                page_number: 1
                page_size: 30
                participants:
                - id: unique_id
                  user_id: unique_id
                  user_name: Zoomie Userton
                  device: Mac
                  ip_address: 117.83.222.228
                  cn: CN
                  city: Nanjing
                  network_type: Wifi
                  join_time: 2017-02-18 01:44:47+00:00
                  leave_time: 2017-02-18 01:45:58+00:00
                  share_application: true
                  share_desktop: true
                  share_whiteboard: true
                  recording: true
      summary: Dashboard meetingdetail
      x-summary-source: derived
  /metrics/meetings:
    post:
      tags:
      - Dashboard
      description: Get Live Meetings and past meetings for a specified period
      operationId: dashboardMeetings
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - from
              - to
              - type
              type: object
              properties:
                type:
                  type: string
                  description: Meeting list type. 1 means live meetings. 2 means past meetings.
                  default: '1'
                from:
                  type: string
                  description: Start date. Only for past meetings.
                to:
                  type: string
                  description: End date. Only for past meetings.
                page_size:
                  type: string
                  description: The amount of records returns within a single API call. Defaults to 30. Max of 100 meetings.
                  default: '30'
                page_number:
                  type: string
                  description: Current page number of returned records. Default to 1.
                  default: '1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                from: 2015-08-02
                to: 2015-09-02
                page_count: 2
                page_number: 1
                page_size: 30
                total_records: 49
                type: Past Meetings
                meetings:
                - uuid: unique_id
                  id: '123456789'
                  host: Zoomie Userton
                  email: email_address
                  user_type: Pro
                  start_time: 2015-08-29 05:36:56+00:00
                  end_time: 2015-08-29 06:36:56+00:00
                  duration: 4 mins
                  participants: 2
                  has_pstn: false
                  has_voip: true
                  has_3rd_party_audio: false
                  has_video: true
                  has_screen_share: false
                  recording: 0
      summary: Dashboard meetings
      x-summary-source: derived
  /metrics/qos:
    post:
      tags:
      - Dashboard
      description: Get the users quality of service in a Zoom Meeting
      operationId: dashboardQos
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - meeting_id
              - type
              type: object
              properties:
                meeting_id:
                  type: string
                  description: The meeting ID.
                type:
                  type: string
                  description: Meeting type. 1 means live meeting. 2 means past meeting.
                user_id:
                  type: string
                  description: The user ID to get user qos.
                page_size:
                  type: string
                  description: The amount of records returns within a single API call. Defaults to 10. Max of 10 records.
                  default: '10'
                page_number:
                  type: string
                  description: Current page number of returned records. Default to 1.
                  default: '1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                meeting_id: unique_id
                user_id: unique_id
                type: Past Meeting
                device: Mac
                ip_address: 112.80.63.6
                cn: CN
                city: Nanjing
                version: 3.5.35288.1217
                user_qos:
                - dateTime: 2015-08-30 06:40:56+00:00
                  audio_input:
                    bitrate: 29 kbps
                    latency: 39 ms
                    jitter: 11 ms
                    avg_loss: 2.5%
                    max_loss: 5.0%
                  audio_output:
                    bitrate: ''
                    latency: ''
                    jitter: ''
                    avg_loss: ''
                    max_loss: ''
                  video_input:
                    bitrate: 77 kbps
                    latency: 84 ms
                    jitter: 4 ms
                    avg_loss: 28.3%
                    max_loss: 28.3%
                    resolution: 480*270
                    frame_rate: 3 fps
                  video_output:
                    bitrate: ''
                    latency: ''
                    jitter: ''
                    avg_loss: ''
                    max_loss: ''
                    resolution: ''
                    frame_rate: ''
                  as_input:
                    bitrate: ''
                    latency: ''
                    jitter: ''
                    avg_loss: ''
                    max_loss: ''
                    resolution: ''
                    frame_rate: ''
                  as_output:
                    bitrate: ''
                    latency: ''
                    jitter: ''
                    avg_loss: ''
                    max_loss: ''
                    resolution: ''
                    frame_rate: ''
                  cpu_usage:
                    zoom_min_cpu_usage: 1%
                    zoom_avg_cpu_usage: 3%
                    zoom_max_cpu_usage: 5%
                    system_max_cpu_usage: 20%
      summary: Dashboard qos
      x-summary-source: derived
  /metrics/webinardetail:
    post:
      tags:
      - Dashboard
      description: Get live and past webinar details
      operationId: dashboardWebinardetail
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - meeting_id
              - type
              type: object
              properties:
                meeting_id:
                  type: string
                  description: 'The meeting ID Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03'
                type:
                  type: string
                  description: Meeting type. 1 means live webinar. 2 means past webinar.
                page_size:
                  type: string
                  description: The amount of records returns within a single API call. Defaults to 30. Max of 100 records.
                  default: '30'
                page_number:
                  type: string
                  description: Current page number of returned records. Default to 1.
                  default: '1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                uuid: unique_id
                id: '123456789'
                type: Past Webinar
                host: Zoomie Userton
                email: email_address
                user_type: Pro
                start_time: 2015-08-30 05:36:56+00:00
                end_time: 2015-08-30 06:36:56+00:00
                duration: 4 mins
                has_pstn: false
                has_voip: true
                has_3rd_party_audio: false
                has_video: true
                has_screen_share: false
                recording: 0
                participants_count: 2
                page_count: 1
                page_number: 1
                page_size: 30
                participants:
                - id: unique_id
                  user_id: unique_id
                  user_name: Zoomie Userton
                  device: Mac
                  ip_address: 117.83.222.228
                  cn: CN
                  city: Nanjing
                  network_type: Wifi
                  join_time: 2017-02-18 01:44:47+00:00
                  leave_time: 2017-02-18 01:45:58+00:00
                  share_application: true
                  share_desktop: true
                  share_whiteboard: true
                  recording: true
      summary: Dashboard webinardetail
      x-summary-source: derived
  /metrics/webinars:
    post:
      tags:
      - Dashboard
      description: Get live webinars and past webinars for a specified period.
      operationId: dashboardWebinars
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - from
              - to
              - type
              type: object
              properties:
                type:
                  type: string
                  description: Webinar list type. 1 means live webinars. 2 means past webinars.
                  default: '1'
                from:
                  type: string
                  description: Start date. Only for past webinars.
                to:
                  type: string
                  description: End date. Only for past webinars.
                page_size:
                  type: string
                  description: The amount of records returns within a single API call. Defaults to 30. Max of 100 webinars.
                  default: '30'
                page_number:
                  type: string
                  description: Current page number of returned records. Default to 1.
                  default: '1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                from: 2015-08-02
                to: 2015-09-02
                page_count: 2
                page_number: 1
                page_size: 30
                total_records: 49
                type: Past Webinars
                meetings:
                - uuid: unique_id
                  id: '123456789'
                  host: Zoomie Userton
                  email: email_address
                  user_type: Pro
                  start_time: 2015-08-29 05:36:56+00:00
                  end_time: 2015-08-29 06:36:56+00:00
                  duration: 4 mins
                  participants: 2
                  has_pstn: false
                  has_voip: true
                  has_3rd_party_audio: false
                  has_video: true
                  has_screen_share: false
                  recording: 0
      summary: Dashboard webinars
      x-summary-source: derived
  /metrics/zoomroomdetail:
    post:
      tags:
      - Dashboard
      description: Get a Zoom Room on Zoom via Zoom ID, return the Zoom Room info.
      operationId: dashboardZoomroomdetail
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - from
              - id
              - to
              type: object
              properties:
                id:
                  type: string
                  description: 'The zoom room ID. Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03'
                from:
                  type: string
                  description: Start date.
                to:
                  type: string
                  description: End date.
                page_size:
                  type: string
                  description: The amount of records returns within a single API call. Defaults to 30. Max of 30 records.
                  default: '30'
                page_number:
                  type: string
                  description: Current page number of returned records. Default to 1.
                  default: '1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                from: 2016-04-12
                to: 2016-04-13
                page_count: 1
                page_number: 1
                page_size: 30
                total_records: 1
                zoom_room:
                  id: unique_id
                  room_name: zoom room
                  email: zoomroom@zoom.us
                  account_type: Work Email
                  passcode: '123'
                  status: Available
                  messages:
                    last_started_time: ''
                    running_time: ''
                    selected_microphone: ''
                    selected_speaker: ''
                    selected_camera: ''
                  meeting_id: ''
                live_meeting:
                  uuid: ''
                  id: 0
                  host: ''
                  email: ''
                  user_type: ''
                  start_time: ''
                  end_time: ''
                  duration: ''
                  participants: 0
                  has_pstn: false
                  has_voip: false
                  has_3rd_party_audio: false
                  has_video: false
                  has_screen_share: false
                  recording: 0
                past_meetings:
                - uuid: unique_id
                  id: '123456789'
                  host: Zoomie Userton
                  email: email_address
                  user_type: ''
                  start_time: ''
                  end_time: ''
                  duration: ''
                  participants: 1
                  has_pstn: false
                  has_voip: false
                  has_3rd_party_audio: false
                  has_video: false
                  has_screen_share: false
                  recording: 0
      summary: Dashboard zoomroomdetail
      x-summary-source: derived
  /metrics/zoomrooms:
    post:
      tags:
      - Dashboard
      description: List all Zoom Rooms on Zoom.
      operationId: dashboardZoomrooms
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                page_size:
                  type: string
                  description: The amount of records returns within a single API call. Defaults to 30. Max of 30 records.
                  default: '30'
                page_number:
                  type: string
                  description: Current page number of returned records. Default to 1.
                  default: '1'
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                page_count: 1
                page_number: 1
                page_size: 30
                total_records: 2
                zoom_rooms:
                - id: unique_id
                  room_name: zoom room1
                  email: zoomroom1@zoom.us
                  account_type: Work Email
                  passcode: '123'
                  status: Available
                  messages:
                    last_started_time: ''
                    running_time: ''
                    selected_microphone: ''
                    selected_speaker: ''
                    selected_camera: ''
                  meeting_id: ''
      summary: Dashboard zoomrooms
      x-summary-source: derived
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: query
    api_secret:
      type: apiKey
      name: api_secret
      in: query
externalDocs:
  description: Zoom REST API Documentation
  url: https://zoom.github.io/api