name: zoom-rooms
description: |
Zoom Rooms API integration guide. Covers room management, device control, scheduling,
health monitoring, and reporting. Use when building conference room management systems,
room availability dashboards, health monitoring solutions, or integrating Zoom Rooms
into workplace management platforms.

Zoom Rooms API

Manage Zoom Rooms devices, settings, scheduling, and health monitoring.

Overview

Zoom Rooms are conference room systems that provide:
- Room status monitoring and health checks
- Device management and control
- Meeting scheduling and calendar integration
- Location hierarchy management
- Real-time health alerts and issue tracking
- Usage reports and capacity planning
- Digital signage and scheduling displays

Key Features

Room Status

Health Status

Choose Your Integration

Core Endpoints

Rooms

Devices

Locations

Meetings & Scheduling

Common Operations

List All Rooms

// GET /rooms
const params = new URLSearchParams({
  page_size: 30,
  page_number: 1,
  status: 'Available'  // Optional filter
});

const response = await fetch(
  `https://api.zoom.us/v2/rooms?${params}`,
  {
    headers: { 'Authorization': `Bearer ${accessToken}` }
  }
);

const rooms = await response.json();
// {
//   "rooms": [
//     {
//       "id": "room_abc123",
//       "name": "Conference Room A",
//       "room_id": "abc123",
//       "location_id": "loc_001",
//       "status": "Available",
//       "health": "healthy",
//       "device_ip": "192.168.1.100"
//     }
//   ],
//   "page_count": 5,
//   "page_number": 1,
//   "page_size": 30,
//   "total_records": 142
// }

Get Room Status

// GET /rooms/{roomId}
const room = await fetch(
  `https://api.zoom.us/v2/rooms/${roomId}`,
  {
    headers: { 'Authorization': `Bearer ${accessToken}` }
  }
).then(r => r.json());

// {
//   "id": "room_abc123",
//   "name": "Conference Room A",
//   "status": "InMeeting",  // Available, InMeeting, Offline, UnderConstruction
//   "health": "healthy",    // healthy, warning, critical
//   "issues": [],
//   "device_ip": "192.168.1.100",
//   "activation_code": "123456",
//   "room_id": "abc123",
//   "location_id": "loc_001"
// }

Update Room Settings

// PATCH /rooms/{roomId}/settings
await fetch(
  `https://api.zoom.us/v2/rooms/${roomId}/settings`,
  {
    method: 'PATCH',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      meeting_security: {
        auto_security: true,
        encryption_type: 'enhanced_encryption'
      },
      notification: {
        upcoming_meeting_alert: true,
        alert_before_start: 5  // minutes
      },
      zoom_rooms: {
        auto_start_scheduled_meeting: true,
        auto_stop_scheduled_meeting: true,
        upcoming_meeting_alert: 10  // minutes
      }
    })
  }
);

Get Room Calendar

// GET /rooms/{roomId}/events
const params = new URLSearchParams({
  from: '2024-01-15',
  to: '2024-01-15'
});

const events = await fetch(
  `https://api.zoom.us/v2/rooms/${roomId}/events?${params}`,
  {
    headers: { 'Authorization': `Bearer ${accessToken}` }
  }
).then(r => r.json());

// {
//   "events": [
//     {
//       "id": "event_001",
//       "meeting_id": "12345678901",
//       "topic": "Team Standup",
//       "start_time": "2024-01-15T09:00:00Z",
//       "end_time": "2024-01-15T09:30:00Z",
//       "host": "[email protected]"
//     }
//   ]
// }

List Devices

// GET /rooms/{roomId}/devices
const devices = await fetch(
  `https://api.zoom.us/v2/rooms/${roomId}/devices`,
  {
    headers: { 'Authorization': `Bearer ${accessToken}` }
  }
).then(r => r.json());

// {
//   "devices": [
//     {
//       "id": "dev_001",
//       "device_type": "Controller",
//       "status": "Online",
//       "app_version": "5.15.0"
//     },
//     {
//       "id": "dev_002",
//       "device_type": "SchedulingDisplay",
//       "status": "Online",
//       "app_version": "5.15.0"
//     }
//   ]
// }

Device Types

Create Location Hierarchy

// POST /rooms/locations
// Create building
const building = await fetch(
  'https://api.zoom.us/v2/rooms/locations',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: 'HQ Building',
      parent_location_id: '',  // Top-level
      type: 'building',
      address: '123 Main St, San Francisco, CA'
    })
  }
).then(r => r.json());

// Create floor
const floor = await fetch(
  'https://api.zoom.us/v2/rooms/locations',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: 'Floor 3',
      parent_location_id: building.id,
      type: 'floor'
    })
  }
).then(r => r.json());

Health Monitoring

Check Room Issues

// Check room issues
const room = await fetch(`https://api.zoom.us/v2/rooms/${roomId}`)
  .then(r => r.json());

if (room.health !== 'healthy') {
  console.log('Issues:', room.issues);
  // [
  //   { "issue": "low_bandwidth", "severity": "warning" },
  //   { "issue": "microphone_not_working", "severity": "critical" }
  // ]
}

Issues Report

// GET /rooms/events/zr_issues
const issues = await fetch(
  `https://api.zoom.us/v2/rooms/events/zr_issues?from=2024-01-01&to=2024-01-31`,
  {
    headers: { 'Authorization': `Bearer ${accessToken}` }
  }
).then(r => r.json());

Reports

Room Usage Report

// GET /report/rooms
const params = new URLSearchParams({
  from: '2024-01-01',
  to: '2024-01-31'
});

const report = await fetch(
  `https://api.zoom.us/v2/report/rooms?${params}`,
  {
    headers: { 'Authorization': `Bearer ${accessToken}` }
  }
).then(r => r.json());

// Usage statistics per room

Webhooks

Zoom Rooms sends real-time events via webhooks:

Webhook Payload

{
  "event": "zoomroom.alert",
  "payload": {
    "account_id": "abc123",
    "object": {
      "id": "room_xyz",
      "room_name": "Conference Room A",
      "issue": "microphone_not_working",
      "severity": "critical",
      "time": "2024-01-15T10:30:00Z"
    }
  }
}

Health Monitoring Alert Handler

// Webhook handler
app.post('/webhook/rooms', (req, res) => {
  const { event, payload } = req.body;

  if (event === 'zoomroom.alert') {
    const { room_name, issue, severity } = payload.object;

    if (severity === 'critical') {
      sendSlackAlert(`Critical issue in ${room_name}: ${issue}`);
    }
  }

  res.sendStatus(200);
});

See zoom-webhooks skill for webhook setup.

Common Use Cases

Prerequisites

1. Zoom Rooms license - Rooms must be provisioned in your account
2. OAuth app - Create in Zoom App Marketplace
3. Scopes - See references/scopes.md for required permissions
4. Admin access - Most operations require admin-level OAuth scopes

Required Scopes

Detailed References

• references/rest-api.md - Complete API endpoints
• references/device-management.md - Device control guide
• references/health-monitoring.md - Health checks and alerts
• references/scheduling.md - Calendar integration
• references/scopes.md - Required OAuth scopes

Resources

• Official docs: https://developers.zoom.us/docs/zoom-rooms/
• API Reference: https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#tag/Zoom-Rooms
• Zoom Rooms Support: https://support.zoom.com/hc/en/zoom-rooms
• Marketplace: https://marketplace.zoom.us/