​
What can you do with it?

The Zoom API allows you to manage video conferencing through programmatic access. You can create and manage meetings, schedule webinars, retrieve user information, update meeting settings, and track participant data for comprehensive video conferencing management.

​
How to use it?

​
Basic Command Structure

/your-zoom-connection [action] [required-parameters] [optional-parameters]

​
Parameters

Required:

  • action - The action to perform (create, get, update, delete, list)
  • userId - User ID (often “me” for current user)
  • meetingId or webinarId - Meeting or webinar ID for specific operations

Optional:

  • topic - Meeting or webinar topic
  • start_time - Scheduled start time
  • duration - Meeting duration in minutes
  • timezone - Meeting timezone
  • settings - Meeting configuration settings

​
Tools

​
List User Meetings

Retrieve a list of meetings for the current user.

Parameters:

  • userId (required) - User ID (use “me” for current user)
  • type (optional) - Meeting type filter
  • page_size (optional) - Number of results per page

Example:

/your-zoom-connection
action: list_meetings
userId: me
page_size: 30

Response:

{
  "meetings": [
    {
      "agenda": "My Meeting",
      "created_at": "2022-03-23T05:31:16Z",
      "duration": 60,
      "host_id": "30R7kT7bTIKSNUFEuH_Qlg",
      "id": 97763643886,
      "join_url": "https://example.com/j/11111",
      "start_time": "2022-03-23T06:00:00Z",
      "timezone": "America/Los_Angeles",
      "topic": "My Meeting",
      "type": 2,
      "uuid": "aDYlohsHRtCd4ii1uC2+hA=="
    }
  ],
  "page_count": 1,
  "total_records": 1
}

​
Get User Details

Retrieve details about a specific user.

Parameters:

  • userId (required) - User ID (use “me” for current user)

Example:

/your-zoom-connection
action: get_user
userId: me

Response:

{
  "id": "FoGxYEx_abcdefg",
  "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-01T12:00:00Z",
  "language": "en-US",
  "phone_number": "+15551234567",
  "role_name": "Owner"
}

​
Create Meeting

Create a new scheduled meeting.

Parameters:

  • userId (required) - User ID (use “me” for current user)
  • topic (required) - Meeting topic
  • type (required) - Meeting type (1=instant, 2=scheduled, 3=recurring)
  • start_time (required) - Meeting start time
  • duration (required) - Meeting duration in minutes
  • timezone (optional) - Meeting timezone
  • agenda (optional) - Meeting agenda
  • settings (optional) - Meeting settings object

Example:

/your-zoom-connection
action: create_meeting
userId: me
topic: Project Kickoff Meeting
type: 2
start_time: 2023-05-15T10:00:00Z
duration: 60
timezone: America/Los_Angeles
agenda: Discuss project goals and timeline
settings: {"host_video": true, "participant_video": true, "waiting_room": true}

Response:

{
  "id": 12345678901,
  "host_id": "FoGxYEx_abcdefg",
  "topic": "Project Kickoff Meeting",
  "type": 2,
  "status": "waiting",
  "start_time": "2023-05-15T10:00:00Z",
  "duration": 60,
  "timezone": "America/Los_Angeles",
  "agenda": "Discuss project goals and timeline",
  "created_at": "2023-05-01T09:30:00Z",
  "start_url": "https://zoom.us/s/12345678901?zak=xxxx",
  "join_url": "https://zoom.us/j/12345678901",
  "password": "123456",
  "settings": {
    "host_video": true,
    "participant_video": true,
    "waiting_room": true
  }
}

​
Get Meeting Details

Retrieve details about a specific meeting.

Parameters:

  • meetingId (required) - Meeting ID

Example:

/your-zoom-connection
action: get_meeting
meetingId: 12345678901

Response:

{
  "id": 12345678901,
  "host_id": "FoGxYEx_abcdefg",
  "topic": "Project Kickoff Meeting",
  "type": 2,
  "status": "waiting",
  "start_time": "2023-05-15T10:00:00Z",
  "duration": 60,
  "timezone": "America/Los_Angeles",
  "agenda": "Discuss project goals and timeline",
  "created_at": "2023-05-01T09:30:00Z",
  "start_url": "https://zoom.us/s/12345678901?zak=xxxx",
  "join_url": "https://zoom.us/j/12345678901",
  "password": "123456",
  "settings": {
    "host_video": true,
    "participant_video": true,
    "waiting_room": true
  }
}

​
Update Meeting

Update an existing meeting’s details.

Parameters:

  • meetingId (required) - Meeting ID
  • topic (optional) - Updated meeting topic
  • duration (optional) - Updated duration
  • agenda (optional) - Updated agenda
  • settings (optional) - Updated meeting settings

Example:

/your-zoom-connection
action: update_meeting
meetingId: 12345678901
topic: Updated Project Kickoff Meeting
duration: 90
agenda: Updated: Discuss project goals, timeline, and resource allocation
settings: {"join_before_host": true, "waiting_room": false}

Response:

{
  "status": "success"
}

​
Delete Meeting

Delete a scheduled meeting.

Parameters:

  • meetingId (required) - Meeting ID

Example:

/your-zoom-connection
action: delete_meeting
meetingId: 12345678901

Response:

{
  "status": "success"
}

​
List Webinars

List all webinars for a specific user.

Parameters:

  • userId (required) - User ID (use “me” for current user)
  • page_size (optional) - Number of results per page

Example:

/your-zoom-connection
action: list_webinars
userId: me
page_size: 30

Response:

{
  "webinars": [
    {
      "uuid": "abcdefghijklmnop",
      "id": 98765432101,
      "host_id": "FoGxYEx_abcdefg",
      "topic": "Quarterly Product Update",
      "type": 5,
      "start_time": "2023-06-15T14:00:00Z",
      "duration": 60,
      "timezone": "America/Los_Angeles",
      "agenda": "New product features and roadmap",
      "created_at": "2023-05-20T10:00:00Z",
      "join_url": "https://zoom.us/j/98765432101"
    }
  ],
  "page_count": 1,
  "total_records": 1
}

​
Create Webinar

Create a new webinar.

Parameters:

  • userId (required) - User ID (use “me” for current user)
  • topic (required) - Webinar topic
  • type (required) - Webinar type (5=webinar, 6=recurring webinar)
  • start_time (required) - Webinar start time
  • duration (required) - Webinar duration in minutes
  • timezone (optional) - Webinar timezone
  • agenda (optional) - Webinar agenda
  • settings (optional) - Webinar settings object

Example:

/your-zoom-connection
action: create_webinar
userId: me
topic: New Feature Launch Webinar
type: 5
start_time: 2023-07-15T15:00:00Z
duration: 60
timezone: America/Los_Angeles
agenda: Introducing our latest product features
settings: {"host_video": true, "practice_session": true, "auto_recording": "cloud"}

Response:

{
  "id": 98765432102,
  "host_id": "FoGxYEx_abcdefg",
  "topic": "New Feature Launch Webinar",
  "type": 5,
  "start_time": "2023-07-15T15:00:00Z",
  "duration": 60,
  "timezone": "America/Los_Angeles",
  "agenda": "Introducing our latest product features",
  "created_at": "2023-06-01T11:30:00Z",
  "join_url": "https://zoom.us/j/98765432102",
  "registration_url": "https://zoom.us/webinar/register/WN_abcdefghijklmno",
  "settings": {
    "host_video": true,
    "practice_session": true,
    "auto_recording": "cloud"
  }
}

​
Get Webinar Participants

Retrieve a list of participants for a specific webinar.

Parameters:

  • webinarId (required) - Webinar ID
  • page_size (optional) - Number of results per page

Example:

/your-zoom-connection
action: get_webinar_participants
webinarId: 98765432101
page_size: 30

Response:

{
  "participants": [
    {
      "id": "user123",
      "name": "Alice Smith",
      "user_email": "alice@example.com",
      "join_time": "2023-06-15T14:05:00Z",
      "leave_time": "2023-06-15T15:00:00Z",
      "duration": 55,
      "attentiveness_score": "Good"
    },
    {
      "id": "user456",
      "name": "Bob Johnson",
      "user_email": "bob@example.com",
      "join_time": "2023-06-15T14:00:00Z",
      "leave_time": "2023-06-15T15:00:00Z",
      "duration": 60,
      "attentiveness_score": "Good"
    }
  ],
  "page_count": 1,
  "total_records": 3
}

​
Notes

Meeting types: 1=instant, 2=scheduled, 3=recurring with no fixed time, 8=recurring with fixed time. Webinar types: 5=webinar, 6=recurring webinar, 9=recurring webinar with fixed time. All times should be in ISO 8601 format. Use “me” as userId for operations on the current user’s account.