S2S OAuth Starter App

https://github.com/zoom/server-to-server-oauth-starter-api
Admin
A boilerplate Express application that provides a functional starting point for building internal...
Tokens:19,668
Snippets:75
Trust Score:8.2
License:MIT
Update:11 months ago
Show doc for...
Tokens:
Raw
### Docker Deployment (Bash)

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

This snippet provides commands for running the application with Redis in Docker containers. It covers starting in development and production modes, running in the background, viewing logs, stopping containers, and accessing the API. Requires Docker and Docker Compose to be installed.

```bash
# Development mode with hot reloading
docker-compose up dev

# Production mode
docker-compose up prod

# Run in background
docker-compose up -d prod

# View logs
docker-compose logs -f

# Stop containers
docker-compose down

# Access the API
curl http://localhost:8080/api/users

# docker-compose.yml configures:
# - Node.js app container with Express server
# - Redis container for token storage
# - Volume mounts for code (dev mode)
# - Network bridge for inter-container communication
# - Port mapping: 8080:8080
```

--------------------------------

### Configure Redis Connection (JavaScript)

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

This code snippet demonstrates connecting to a Redis server using JavaScript for token storage. It includes connection establishment, event listeners for connection status, and examples of setting, retrieving, expiring, and deleting keys. This setup enables persistent storage and management of zoom tokens.

```javascript
// configs/redis.js
const redis = require('./configs/redis');

// Connect to Redis
(async () => {
  await redis.connect();
})();

// Listen for connection events
redis.on('connect', (err) => {
  if (err) {
    console.log('Could not establish connection with redis');
  } else {
    console.log('Connected to redis successfully');
  }
});

// Store data with expiration
await redis.set('access_token', 'eyJhbGc...', { EX: 3600 });

// Retrieve data
const token = await redis.get('access_token');

// Set expiration on existing key
await redis.expire('access_token', 3600);

// Delete key
await redis.del('access_token');

// Configuration connects to 'redis' host on port 6379
// This hostname resolves in Docker Compose environment
```

--------------------------------

### Environment Configuration (.env)

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

This snippet shows how to configure OAuth credentials and application settings using environment variables.  It includes examples for ZOOM_ACCOUNT_ID, ZOOM_CLIENT_ID, ZOOM_CLIENT_SECRET, and PORT.  These variables are essential for authenticating with the Zoom API. 

```bash
# .env file
ZOOM_ACCOUNT_ID=your_account_id_here
ZOOM_CLIENT_ID=your_client_id_here
ZOOM_CLIENT_SECRET=your_client_secret_here
PORT=8080

# Access in application:
# process.env.ZOOM_ACCOUNT_ID
# process.env.ZOOM_CLIENT_ID
# process.env.ZOOM_CLIENT_SECRET
# process.env.PORT || 8080

# Get credentials from:
# 1. Go to https://marketplace.zoom.us/
# 2. Create Server-to-Server OAuth app
# 3. Add required scopes: meeting:write:admin, recording:write:admin, report:read:admin, user:write:admin, webinar:write:admin
# 4. Activate app and copy credentials
```

--------------------------------

### Get Webinar Details

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves detailed information about a specific webinar, including its settings and panelists. This is a GET request to the webinar endpoint. Dependencies: curl. Input: Webinar ID. Output: JSON object with webinar details.

```bash
# Get webinar details
curl http://localhost:8080/api/webinars/123456789
```

--------------------------------

### GET /api/webinars/{webinarId}

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves detailed information about a specific webinar, including panelists and settings.

```APIDOC
## GET /api/webinars/{webinarId}

### Description
Retrieves detailed information about a specific webinar, including its topic, schedule, settings, and associated panelists.

### Method
GET

### Endpoint
/api/webinars/{webinarId}

### Parameters
#### Path Parameters
- **webinarId** (string) - Required - The unique identifier of the webinar.

### Request Example
```bash
curl http://localhost:8080/api/webinars/123456789
```

### Response
#### Success Response (200)
- **uuid** (string) - The unique UUID of the webinar.
- **id** (integer) - The numeric ID of the webinar.
- **host_id** (string) - The ID of the user hosting the webinar.
- **topic** (string) - The topic of the webinar.
- **type** (integer) - The type of the webinar.
- **start_time** (string) - The ISO 8601 timestamp for the webinar start.
- **duration** (integer) - The duration of the webinar in minutes.
- **timezone** (string) - The timezone of the webinar.
- **agenda** (string) - The agenda for the webinar.
- **settings** (object) - Configuration settings for the webinar.
  - **host_video** (boolean) - Whether the host's video is enabled.
  - **panelists_video** (boolean) - Whether the panelists' video is enabled.
  - **practice_session** (boolean) - Whether the practice session is enabled.
  - **hd_video** (boolean) - Whether HD video is enabled.
  - **approval_type** (integer) - The registration approval type.
  - **registration_type** (integer) - The registration type.
  - **question_and_answer** (object) - Settings for the Q&A feature.
    - **enable** (boolean) - Whether Q&A is enabled.
    - **allow_anonymous_questions** (boolean) - Whether anonymous questions are allowed.

#### Response Example
```json
{
  "uuid": "webinar123",
  "id": 123456789,
  "host_id": "abc123xyz",
  "topic": "Product Launch Event",
  "type": 5,
  "start_time": "2025-11-15T18:00:00Z",
  "duration": 120,
  "timezone": "America/New_York",
  "agenda": "Introducing our new product line",
  "settings": {
    "host_video": true,
    "panelists_video": true,
    "practice_session": true,
    "hd_video": true,
    "approval_type": 2,
    "registration_type": 1,
    "question_and_answer": {
      "enable": true,
      "allow_anonymous_questions": false
    }
  }
}
```
```

--------------------------------

### GET /api/users

Source: https://github.com/zoom/server-to-server-oauth-starter-api/blob/main/README.md

Retrieves a list of all users on the Zoom account. Requires authentication via server-to-server OAuth.

```APIDOC
## GET /api/users

### Description
Retrieves a list of all users on the Zoom account.

### Method
GET

### Endpoint
/api/users

### Parameters
None

### Response
#### Success Response (200)
- **users** (array) - List of user objects

#### Response Example
{
  "users": [
    {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string"
    }
  ]
}
```

--------------------------------

### GET /api/webinars/{webinarId}/registrants

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves all registrants for a webinar with their registration status.

```APIDOC
## GET /api/webinars/{webinarId}/registrants

### Description
Retrieves a list of all registrants for a specified webinar. You can filter registrants by their status.

### Method
GET

### Endpoint
/api/webinars/{webinarId}/registrants

### Parameters
#### Path Parameters
- **webinarId** (string) - Required - The unique identifier of the webinar.

#### Query Parameters
- **status** (string) - Optional - Filters registrants by status. Possible values: `approved`, `denied`, `pending`.

### Request Example
```bash
# List all registrants
curl http://localhost:8080/api/webinars/123456789/registrants

# Filter by status
curl "http://localhost:8080/api/webinars/123456789/registrants?status=approved"
```

### Response
#### Success Response (200)
- **page_count** (integer) - The number of pages for the results.
- **page_size** (integer) - The number of records per page.
- **total_records** (integer) - The total number of registrants.
- **registrants** (array) - A list of registrant objects.
  - **id** (string) - The unique identifier for the registrant.
  - **email** (string) - The email address of the registrant.
  - **first_name** (string) - The first name of the registrant.
  - **last_name** (string) - The last name of the registrant.
  - **status** (string) - The registration status (`approved`, `denied`, `pending`).
  - **create_time** (string) - The ISO 8601 timestamp when the registrant registered.
  - **join_url** (string) - The URL for the registrant to join the webinar.

#### Response Example
```json
{
  "page_count": 1,
  "page_size": 30,
  "total_records": 45,
  "registrants": [
    {
      "id": "reg123",
      "email": "attendee@example.com",
      "first_name": "Sarah",
      "last_name": "Johnson",
      "status": "approved",
      "create_time": "2025-11-08T10:30:00Z",
      "join_url": "https://zoom.us/w/123456789?tk=xyz"
    }
  ]
}
```
```

--------------------------------

### Create new API route in Express.js

Source: https://github.com/zoom/server-to-server-oauth-starter-api/blob/main/README.md

Demonstrates how to create a new API route file for the Zoom API in Express.js. The example shows a route for fetching meeting metrics, including error handling and configuration from constants.

```JavaScript
// create a new file:
// routes/api/dashboards.js
const express = require("express");
const axios = require("axios");
const qs = require("query-string");

const errorHandler = require("../../utils/errorHandler");
const { ZOOM_API_BASE_URL } = require("../../constants");

const router = express.Router();

router.get("/metrics/meetings", async (req, res) => {
  const { headerConfig, params } = req;

  try {
    const request = await axios.get(
      `${ZOOM_API_BASE_URL}/metrics/meetings`,
      headerConfig
    );
    return res.json(request.data);
  } catch (err) {
    return errorHandler(err, res, `Error fetching list of meetings`);
  }
});

module.exports = router;
```

--------------------------------

### GET /api/users/:userId

Source: https://github.com/zoom/server-to-server-oauth-starter-api/blob/main/README.md

Retrieves details for a specific user by their ID.

```APIDOC
## GET /api/users/:userId

### Description
Retrieves details for a specific user.

### Method
GET

### Endpoint
/api/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The user's ID

### Response
#### Success Response (200)
- **id** (string) - User ID
- **email** (string) - User email
- **first_name** (string) - User first name
- **last_name** (string) - User last name
- **type** (integer) - User type
- **status** (string) - User status

#### Response Example
{
  "id": "uFBT3sddQ22u3k2MC0Hjw",
  "email": "user@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "type": 2,
  "status": "active"
}
```

--------------------------------

### Get User Settings - Bash

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves all configuration settings for a specific Zoom user, including preferences for meetings, recording, telephony, and other features. The response is a JSON object detailing these settings.

```bash
curl http://localhost:8080/api/users/abc123xyz/settings

# Expected response:
# {
#   "schedule_meeting": {
#     "host_video": true,
#     "participants_video": true,
#     "audio_type": "both",
#     "join_before_host": false,
#     "mute_upon_entry": true
#   },
#   "in_meeting": {
#     "e2e_encryption": false,
#     "chat": true,
#     "private_chat": true,
#     "auto_saving_chat": false
#   },
#   "recording": {
#     "local_recording": true,
#     "cloud_recording": true,
#     "auto_recording": "none"
#   }
# }
```

--------------------------------

### Get User Settings API

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves comprehensive user settings including meeting, recording, telephony, and feature configurations.

```APIDOC
## GET /api/users/{userId}/settings

### Description
Retrieves comprehensive user settings including meeting, recording, telephony, and feature configurations.

### Method
GET

### Endpoint
/api/users/{userId}/settings

#### Path Parameters
- **userId** (string) - Required - The unique ID of the user whose settings are to be retrieved.

### Request Example
```bash
curl http://localhost:8080/api/users/abc123xyz/settings
```

### Response
#### Success Response (200)
Returns a JSON object containing various user settings categories:
- **schedule_meeting** (object) - Settings related to scheduling meetings.
  - **host_video** (boolean) - Whether the host's video is on by default.
  - **participants_video** (boolean) - Whether participants' video is on by default.
  - **audio_type** (string) - Allowed audio types (e.g., 'both', 'telephony', 'voip').
  - **join_before_host** (boolean) - Whether participants can join before the host.
  - **mute_upon_entry** (boolean) - Whether participants are muted upon entry.
- **in_meeting** (object) - Settings for in-meeting features.
  - **e2e_encryption** (boolean) - Whether end-to-end encryption is enabled.
  - **chat** (boolean) - Whether in-meeting chat is enabled.
  - **private_chat** (boolean) - Whether private chat between participants is allowed.
  - **auto_saving_chat** (boolean) - Whether chat messages are automatically saved.
- **recording** (object) - Settings related to meeting recording.
  - **local_recording** (boolean) - Whether local recording is enabled.
  - **cloud_recording** (boolean) - Whether cloud recording is enabled.
  - **auto_recording** (string) - Auto-recording setting ('none', 'local', 'cloud').

#### Response Example
```json
{
  "schedule_meeting": {
    "host_video": true,
    "participants_video": true,
    "audio_type": "both",
    "join_before_host": false,
    "mute_upon_entry": true
  },
  "in_meeting": {
    "e2e_encryption": false,
    "chat": true,
    "private_chat": true,
    "auto_saving_chat": false
  },
  "recording": {
    "local_recording": true,
    "cloud_recording": true,
    "auto_recording": "none"
  }
}
```
```

--------------------------------

### GET /api/users/{userId}/recordings

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves all cloud recordings for a user within a specified date range.

```APIDOC
## GET /api/users/{userId}/recordings

### Description
Retrieves all cloud recordings for a user within a specified date range.

### Method
GET

### Endpoint
/api/users/{userId}/recordings

#### Path Parameters
- **userId** (string) - Required - The ID of the user whose recordings are to be retrieved.

#### Query Parameters
- **from** (string) - Required - The start date for the recording range (YYYY-MM-DD).
- **to** (string) - Required - The end date for the recording range (YYYY-MM-DD).

### Response
#### Success Response (200)
- **from** (string) - The start date of the queried range.
- **to** (string) - The end date of the queried range.
- **total_records** (integer) - The total number of recording sets.
- **meetings** (array) - A list of recording objects associated with meetings.
  - **uuid** (string) - The unique identifier for the meeting.
  - **id** (integer) - The meeting ID.
  - **topic** (string) - The topic of the meeting.
  - **start_time** (string) - The start time of the meeting in ISO 8601 format.
  - **duration** (integer) - The duration of the meeting in minutes.
  - **total_size** (integer) - The total size of all recordings for the meeting in bytes.
  - **recording_count** (integer) - The number of individual recording files for the meeting.
  - **recording_files** (array) - A list of individual recording file details.
    - **id** (string) - The unique identifier for the recording file.
    - **recording_start** (string) - The start time of the recording in ISO 8601 format.
    - **recording_end** (string) - The end time of the recording in ISO 8601 format.
    - **file_type** (string) - The type of the recording file (e.g., 'MP4').
    - **file_size** (integer) - The size of the recording file in bytes.
    - **download_url** (string) - The URL to download the recording file.

### Response Example
```json
{
  "from": "2025-11-01",
  "to": "2025-11-08",
  "total_records": 3,
  "meetings": [
    {
      "uuid": "rec123",
      "id": 987654321,
      "topic": "Team Standup",
      "start_time": "2025-11-05T14:00:00Z",
      "duration": 30,
      "total_size": 52428800,
      "recording_count": 2,
      "recording_files": [
        {
          "id": "file123",
          "recording_start": "2025-11-05T14:00:05Z",
          "recording_end": "2025-11-05T14:30:10Z",
          "file_type": "MP4",
          "file_size": 26214400,
          "download_url": "https://zoom.us/rec/download/..."
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Get meeting details via Zoom API (bash)

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves comprehensive information about a specific Zoom meeting.

```bash
curl http://localhost:8080/api/meetings/987654321
```

--------------------------------

### GET /api/users/{userId}/webinars

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves all scheduled webinars for a specific user.

```APIDOC
## GET /api/users/{userId}/webinars

### Description
Retrieves all scheduled webinars for a specific user.

### Method
GET

### Endpoint
/api/users/{userId}/webinars

#### Path Parameters
- **userId** (string) - Required - The ID of the user whose webinars are to be listed.

### Response
#### Success Response (200)
- **page_count** (integer) - The total number of pages available.
- **page_size** (integer) - The number of records per page.
- **total_records** (integer) - The total number of webinars.
- **webinars** (array) - A list of webinar objects.
  - **uuid** (string) - The unique identifier for the webinar.
  - **id** (integer) - The webinar ID.
  - **host_id** (string) - The ID of the user who hosted the webinar.
  - **topic** (string) - The topic of the webinar.
  - **type** (integer) - The webinar type (e.g., 5 for webinar).
  - **start_time** (string) - The start time of the webinar in ISO 8601 format.
  - **duration** (integer) - The duration of the webinar in minutes.
  - **timezone** (string) - The timezone of the webinar.

### Response Example
```json
{
  "page_count": 1,
  "page_size": 30,
  "total_records": 2,
  "webinars": [
    {
      "uuid": "webinar123",
      "id": 123456789,
      "host_id": "abc123xyz",
      "topic": "Product Launch",
      "type": 5,
      "start_time": "2025-11-15T18:00:00Z",
      "duration": 60,
      "timezone": "America/New_York"
    }
  ]
}
```
```

--------------------------------

### GET /api/meetings/:meetingId

Source: https://github.com/zoom/server-to-server-oauth-starter-api/blob/main/README.md

Retrieves details for a specific meeting by its ID.

```APIDOC
## GET /api/meetings/:meetingId

### Description
Retrieves details for a specific meeting.

### Method
GET

### Endpoint
/api/meetings/{meetingId}

### Parameters
#### Path Parameters
- **meetingId** (string) - Required - The meeting's ID

### Response
#### Success Response (200)
- **id** (string) - Meeting ID
- **topic** (string) - Meeting topic
- **start_time** (string) - Meeting start time
- **duration** (integer) - Meeting duration in minutes
- **timezone** (string) - Timezone
- **join_url** (string) - Join URL

#### Response Example
{
  "id": "123456789",
  "topic": "Team Meeting",
  "start_time": "2023-05-15T10:00:00Z",
  "duration": 60,
  "timezone": "America/Los_Angeles",
  "join_url": "https://zoom.us/j/123456789"
}
```

--------------------------------

### GET /api/meetings/{meetingId}

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves detailed information about a specific meeting including settings and join URLs.

```APIDOC
## GET /api/meetings/{meetingId}

### Description
Retrieves detailed information about a specific meeting including settings and join URLs.

### Method
GET

### Endpoint
/api/meetings/{meetingId}

#### Path Parameters
- **meetingId** (integer) - Required - The ID of the meeting to retrieve.

### Response
#### Success Response (200)
- **uuid** (string) - The unique identifier for the meeting.
- **id** (integer) - The meeting ID.
- **host_id** (string) - The ID of the user who hosted the meeting.
- **topic** (string) - The topic of the meeting.
- **type** (integer) - The meeting type.
- **status** (string) - The current status of the meeting (e.g., 'waiting', 'live').
- **start_time** (string) - The start time of the meeting in ISO 8601 format.
- **duration** (integer) - The duration of the meeting in minutes.
- **timezone** (string) - The timezone of the meeting.
- **join_url** (string) - The URL for participants to join the meeting.
- **settings** (object) - Settings for the meeting.
  - **host_video** (boolean) - Whether host video is enabled.
  - **participant_video** (boolean) - Whether participant video is enabled.
  - **join_before_host** (boolean) - Whether participants can join before the host.
  - **mute_upon_entry** (boolean) - Whether participants are muted upon entry.
  - **watermark** (boolean) - Whether watermark is enabled.
  - **waiting_room** (boolean) - Whether the waiting room is enabled.

### Response Example
```json
{
  "uuid": "meeting123",
  "id": 987654321,
  "host_id": "abc123xyz",
  "topic": "Weekly Review",
  "type": 2,
  "status": "waiting",
  "start_time": "2025-11-10T15:00:00Z",
  "duration": 60,
  "timezone": "America/Los_Angeles",
  "join_url": "https://zoom.us/j/987654321?pwd=xyz",
  "settings": {
    "host_video": true,
    "participant_video": true,
    "join_before_host": false,
    "mute_upon_entry": true,
    "watermark": false,
    "waiting_room": true
  }
}
```
```

--------------------------------

### Get Webinar Participant Report (Bash)

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves attendance data and engagement metrics for past webinars. Requires the webinar ID. Returns a JSON object containing pagination details and a list of participants with their session data.

```bash
# Get participant report
curl http://localhost:8080/api/webinars/123456789/report/participants

# Expected response:
# {
#   "page_count": 1,
#   "page_size": 30,
#   "total_records": 42,
#   "participants": [
#     {
#       "id": "participant123",
#       "user_id": "user123",
#       "name": "Sarah Johnson",
#       "user_email": "sarah@example.com",
#       "join_time": "2025-11-05T18:00:15Z",
#       "leave_time": "2025-11-05T19:58:30Z",
#       "duration": 7095,
#       "attentiveness_score": 92
#     }
#   ]
# }
```

--------------------------------

### GET /api/users/{userId}/meetings

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves all scheduled meetings for a specific user with pagination support.

```APIDOC
## GET /api/users/{userId}/meetings

### Description
Retrieves all scheduled meetings for a specific user with pagination support.

### Method
GET

### Endpoint
/api/users/{userId}/meetings

#### Path Parameters
- **userId** (string) - Required - The ID of the user whose meetings are to be listed.

#### Query Parameters
- **next_page_token** (string) - Optional - Token for retrieving the next page of results.

### Response
#### Success Response (200)
- **page_count** (integer) - The total number of pages available.
- **page_size** (integer) - The number of records per page.
- **total_records** (integer) - The total number of meetings.
- **meetings** (array) - A list of meeting objects.
  - **uuid** (string) - The unique identifier for the meeting.
  - **id** (integer) - The meeting ID.
  - **host_id** (string) - The ID of the user who hosted the meeting.
  - **topic** (string) - The topic of the meeting.
  - **type** (integer) - The meeting type (e.g., 2 for scheduled meeting).
  - **start_time** (string) - The start time of the meeting in ISO 8601 format.
  - **duration** (integer) - The duration of the meeting in minutes.
  - **timezone** (string) - The timezone of the meeting.
  - **join_url** (string) - The URL for participants to join the meeting.

### Response Example
```json
{
  "page_count": 1,
  "page_size": 30,
  "total_records": 5,
  "meetings": [
    {
      "uuid": "abc123",
      "id": 987654321,
      "host_id": "abc123xyz",
      "topic": "Team Standup",
      "type": 2,
      "start_time": "2025-11-10T14:00:00Z",
      "duration": 30,
      "timezone": "America/Los_Angeles",
      "join_url": "https://zoom.us/j/987654321"
    }
  ]
}
```
```

--------------------------------

### List Webinar Registrants

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves all registrants for a webinar, with options to filter by status. This uses a GET request to the registrants endpoint. Dependencies: curl. Input: Webinar ID, optional status. Output: JSON object with registrant list.

```bash
# List all registrants
curl http://localhost:8080/api/webinars/123456789/registrants

# Filter by status
curl "http://localhost:8080/api/webinars/123456789/registrants?status=approved"
```

--------------------------------

### GET /api/meetings/{meetingId}/report/participants

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves detailed participant information for past meetings, including join/leave times and duration.

```APIDOC
## GET /api/meetings/{meetingId}/report/participants

### Description
Retrieves detailed participant information for past meetings, including join and leave times, and duration.

### Method
GET

### Endpoint
/api/meetings/{meetingId}/report/participants

### Parameters
#### Path Parameters
- **meetingId** (string) - Required - The ID of the meeting for which to retrieve the participant report.

### Request Example
```bash
curl "http://localhost:8080/api/meetings/987654321/report/participants"
```

### Response
#### Success Response (200)
- **page_count** (integer) - The number of pages for the results.
- **page_size** (integer) - The number of records per page.
- **total_records** (integer) - The total number of participants.
- **participants** (array) - A list of participant objects.
  - **id** (string) - The participant's unique identifier.
  - **user_id** (string) - The user's unique identifier.
  - **name** (string) - The name of the participant.
  - **user_email** (string) - The email address of the participant.
  - **join_time** (string) - The ISO 8601 timestamp when the participant joined.
  - **leave_time** (string) - The ISO 8601 timestamp when the participant left.
  - **duration** (integer) - The duration the participant was in the meeting (in seconds).
  - **attentiveness_score** (integer) - The attentiveness score of the participant.

#### Response Example
```json
{
  "page_count": 1,
  "page_size": 30,
  "total_records": 8,
  "participants": [
    {
      "id": "participant123",
      "user_id": "user123",
      "name": "John Doe",
      "user_email": "john@example.com",
      "join_time": "2025-11-05T14:00:30Z",
      "leave_time": "2025-11-05T14:28:15Z",
      "duration": 1665,
      "attentiveness_score": 85
    }
  ]
}
```
```

--------------------------------

### Get User Details API

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves detailed information about a specific user by their user ID or email address.

```APIDOC
## GET /api/users/{userIdOrEmail}

### Description
Retrieves detailed information about a specific user by their user ID or email address.

### Method
GET

### Endpoint
/api/users/{userIdOrEmail}

#### Path Parameters
- **userIdOrEmail** (string) - Required - The unique ID or email address of the user.

### Request Example
```bash
# Get user by ID
curl http://localhost:8080/api/users/abc123xyz

# Get user by email
curl http://localhost:8080/api/users/user@example.com
```

### Response
#### Success Response (200)
- **id** (string) - The user's unique identifier.
- **first_name** (string) - The user's first name.
- **last_name** (string) - The user's last name.
- **email** (string) - The user's email address.
- **type** (integer) - The user's type.
- **status** (string) - The user's current status.
- **pmi** (integer) - The user's Personal Meeting ID.
- **timezone** (string) - The user's timezone.
- **created_at** (string) - The timestamp when the user was created (ISO 8601 format).

#### Response Example
```json
{
  "id": "abc123xyz",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "type": 2,
  "status": "active",
  "pmi": 1234567890,
  "timezone": "America/Los_Angeles",
  "created_at": "2023-01-15T10:30:00Z"
}
```
```

--------------------------------

### Get User Details - Bash

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves detailed information for a specific Zoom user using their ID or email address in the request path. The response contains comprehensive user profile data.

```bash
curl http://localhost:8080/api/users/abc123xyz

curl http://localhost:8080/api/users/user@example.com

# Expected response:
# {
#   "id": "abc123xyz",
#   "first_name": "John",
#   "last_name": "Doe",
#   "email": "john.doe@example.com",
#   "type": 2,
#   "status": "active",
#   "pmi": 1234567890,
#   "timezone": "America/Los_Angeles",
#   "created_at": "2023-01-15T10:30:00Z"
# }
```

--------------------------------

### Create meeting via Zoom API (bash)

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Schedules a new Zoom meeting with detailed configuration.

```bash
curl -X POST http://localhost:8080/api/meetings/abc123xyz \
  -H "Content-Type: application/json" \
  -d '{
    "topic": "Project Planning Session",
    "type": 2,
    "start_time": "2025-11-12T10:00:00Z",
    "duration": 60,
    "timezone": "America/Los_Angeles",
    "agenda": "Discuss Q4 roadmap and deliverables",
    "settings": {
      "host_video": true,
      "participant_video": true,
      "join_before_host": false,
      "mute_upon_entry": true,
      "waiting_room": true,
      "auto_recording": "cloud"
    }
  }'
```

--------------------------------

### POST /api/users/add

Source: https://github.com/zoom/server-to-server-oauth-starter-api/blob/main/README.md

Creates a new user on the Zoom account. Requires appropriate admin permissions.

```APIDOC
## POST /api/users/add

### Description
Creates a new user on the Zoom account.

### Method
POST

### Endpoint
/api/users/add

### Request Body
- **email** (string) - Required - User's email address
- **first_name** (string) - Required - User's first name
- **last_name** (string) - Required - User's last name
- **type** (integer) - Required - User type (1 = basic, 2 = licensed, 3 = on-prem)

### Request Example
{
  "email": "user@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "type": 2
}

### Response
#### Success Response (201)
- **id** (string) - The created user's ID
- **email** (string) - The created user's email

#### Response Example
{
  "id": "uFBT3sddQ22u3k2MC0Hjw",
  "email": "user@example.com"
}
```

--------------------------------

### Get Meeting Participant Report

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves a report of participants for a past meeting, including their join/leave times and duration. This uses a GET request to the specific report endpoint. Dependencies: curl. Input: Meeting ID. Output: JSON object with participant details.

```bash
# Get participant report
curl "http://localhost:8080/api/meetings/987654321/report/participants"
```

--------------------------------

### POST /api/webinars/:userId

Source: https://github.com/zoom/server-to-server-oauth-starter-api/blob/main/README.md

Creates a new webinar for the specified user.

```APIDOC
## POST /api/webinars/:userId

### Description
Creates a new webinar for the specified user.

### Method
POST

### Endpoint
/api/webinars/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The user ID who will host the webinar

### Request Body
- **topic** (string) - Required - Webinar topic
- **start_time** (string) - Required - Webinar start time (ISO 8601 format)
- **duration** (integer) - Required - Duration in minutes
- **timezone** (string) - Required - Timezone
- **settings** (object) - Optional - Webinar settings

### Request Example
{
  "topic": "Product Launch",
  "start_time": "2023-05-20T14:00:00Z",
  "duration": 90,
  "timezone": "America/New_York",
  "settings": {
    "host_video": true,
    "panelists_video": true,
    "practice_session": true
  }
}

### Response
#### Success Response (201)
- **id** (string) - Webinar ID
- **join_url** (string) - Join URL
- "registration_url" (string) - Registration URL

#### Response Example
{
  "id": "987654321",
  "join_url": "https://zoom.us/w/987654321",
  "registration_url": "https://zoom.us/webinar/register/WN_abc123def456"
}
```

--------------------------------

### POST /api/webinars/{userId}

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Creates a new webinar for a specific user with registration and Q&A settings.

```APIDOC
## POST /api/webinars/{userId}

### Description
Creates a new webinar for a specified user, allowing configuration of topic, schedule, and various settings like registration and Q&A.

### Method
POST

### Endpoint
/api/webinars/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user for whom the webinar will be created.

#### Request Body
- **topic** (string) - Required - The topic of the webinar.
- **type** (integer) - Required - The type of the webinar (e.g., 5 for recurring).
- **start_time** (string) - Required - The ISO 8601 timestamp for when the webinar should start.
- **duration** (integer) - Required - The duration of the webinar in minutes.
- **timezone** (string) - Required - The timezone for the webinar.
- **agenda** (string) - Optional - The agenda for the webinar.
- **settings** (object) - Optional - Configuration settings for the webinar.
  - **host_video** (boolean) - Whether the host's video is enabled.
  - **panelists_video** (boolean) - Whether the panelists' video is enabled.
  - **practice_session** (boolean) - Whether the practice session is enabled.
  - **hd_video** (boolean) - Whether HD video is enabled.
  - **approval_type** (integer) - The registration approval type.
  - **registration_type** (integer) - The registration type.
  - **question_and_answer** (object) - Settings for the Q&A feature.
    - **enable** (boolean) - Whether Q&A is enabled.
    - **allow_anonymous_questions** (boolean) - Whether anonymous questions are allowed.
  - **email_notification** (boolean) - Whether email notifications are enabled.

### Request Example
```bash
curl -X POST http://localhost:8080/api/webinars/abc123xyz \
  -H "Content-Type: application/json" \
  -d '{ \
    "topic": "Annual Product Showcase", \
    "type": 5, \
    "start_time": "2025-11-20T19:00:00Z", \
    "duration": 90, \
    "timezone": "America/New_York", \
    "agenda": "Showcasing 2025 product innovations", \
    "settings": { \
      "host_video": true, \
      "panelists_video": true, \
      "practice_session": true, \
      "hd_video": true, \
      "approval_type": 0, \
      "registration_type": 1, \
      "question_and_answer": { \
        "enable": true, \
        "allow_anonymous_questions": true \
      }, \
      "email_notification": true \
    } \
  }'
```

### Response
#### Success Response (201)
- **uuid** (string) - The unique UUID of the newly created webinar.
- **id** (integer) - The numeric ID of the newly created webinar.
- **host_id** (string) - The ID of the user hosting the webinar.
- **topic** (string) - The topic of the webinar.
- **start_time** (string) - The ISO 8601 timestamp for the webinar start.
- **join_url** (string) - The URL to join the webinar.
- **registration_url** (string) - The URL for webinar registration.

#### Response Example
```json
{
  "uuid": "newwebinar123",
  "id": 999888777,
  "host_id": "abc123xyz",
  "topic": "Annual Product Showcase",
  "start_time": "2025-11-20T19:00:00Z",
  "join_url": "https://zoom.us/j/999888777",
  "registration_url": "https://zoom.us/webinar/register/WN_xxx"
}
```
```

--------------------------------

### Create Webinar

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Creates a new webinar for a specified user with custom settings for registration and Q&A. This uses a POST request with a JSON payload. Dependencies: curl. Input: User ID, webinar details (JSON). Output: JSON object with new webinar details.

```bash
# Create a webinar
curl -X POST http://localhost:8080/api/webinars/abc123xyz \
  -H "Content-Type: application/json" \
  -d '{
    "topic": "Annual Product Showcase",
    "type": 5,
    "start_time": "2025-11-20T19:00:00Z",
    "duration": 90,
    "timezone": "America/New_York",
    "agenda": "Showcasing 2025 product innovations",
    "settings": {
      "host_video": true,
      "panelists_video": true,
      "practice_session": true,
      "hd_video": true,
      "approval_type": 0,
      "registration_type": 1,
      "question_and_answer": {
        "enable": true,
        "allow_anonymous_questions": true
      },
      "email_notification": true
    }
  }'
```

--------------------------------

### Create User - Bash

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Creates a new user in Zoom by sending user information in JSON format via a POST request. The response includes the newly created user's details.

```bash
curl -X POST http://localhost:8080/api/users/add \
  -H "Content-Type: application/json" \
  -d '{
    "action": "create",
    "user_info": {
      "email": "newuser@example.com",
      "type": 1,
      "first_name": "Jane",
      "last_name": "Smith"
    }
  }'

# Expected response:
# {
#   "id": "xyz789abc",
#   "first_name": "Jane",
#   "last_name": "Smith",
#   "email": "newuser@example.com",
#   "type": 1
# }
```

--------------------------------

### POST /api/webinars/{webinarId}/registrants

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Registers a new participant for a webinar.

```APIDOC
## POST /api/webinars/{webinarId}/registrants

### Description
Registers a new participant for a specified webinar. Requires attendee details such as email and name.

### Method
POST

### Endpoint
/api/webinars/{webinarId}/registrants

### Parameters
#### Path Parameters
- **webinarId** (string) - Required - The unique identifier of the webinar for which to register.

#### Request Body
- **email** (string) - Required - The email address of the registrant.
- **first_name** (string) - Required - The first name of the registrant.
- **last_name** (string) - Required - The last name of the registrant.
- **org** (string) - Optional - The organization of the registrant.
- **job_title** (string) - Optional - The job title of the registrant.

### Request Example
```bash
curl -X POST http://localhost:8080/api/webinars/123456789/registrants \
  -H "Content-Type: application/json" \
  -d '{ \
    "email": "newattendee@example.com", \
    "first_name": "Michael", \
    "last_name": "Chen", \
    "org": "Tech Corp", \
    "job_title": "Engineering Manager" \
  }'
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the created registrant.
- **registrant_id** (string) - The internal ID assigned to the registrant by Zoom.
- **topic** (string) - The topic of the webinar.

#### Response Example
```json
{
  "id": "newreg456",
  "registrant_id": "reg456",
  "topic": "Product Launch Event"
}
```
```

--------------------------------

### List user recordings via Zoom API (bash)

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves cloud recordings for a Zoom user within date range.

```bash
curl "http://localhost:8080/api/users/abc123xyz/recordings?from=2025-11-01&to=2025-11-08"
```

--------------------------------

### List user webinars via Zoom API (bash)

Source: https://context7.com/zoom/server-to-server-oauth-starter-api/llms.txt

Retrieves all scheduled webinars for a Zoom user.

```bash
curl http://localhost:8080/api/users/abc123xyz/webinars
```
Tokens:
Raw