Zoom Integration — ModuleX AI

Overview

Add Zoom to any ModuleX agent or workflow. Video conferencing, meetings, webinars, and team chat platform via the Zoom REST API (api.zoom.us/v2).

Categories: Communication · Video Conferencing · Productivity & Collaboration · Auth: OAuth2 · Actions: 23

Authentication

OAuth2 Authentication

Connect using Zoom OAuth (recommended)

Required Credentials

Field	Description	Required	Format
Client ID	Zoom OAuth App Client ID	Yes	`-`
Client Secret	Zoom OAuth App Client Secret	Yes	`-`

OAuth Configuration

Authorization URL: https://zoom.us/oauth/authorize
Token URL: https://zoom.us/oauth/token
Scopes: meeting:write:admin, meeting:read:admin, recording:read:admin, chat_message:write, chat_channel:read, user:read:admin, user:write:admin, phone:read:admin, webinar:read:admin, webinar:write:admin, report:read:admin

Available Actions

create_meeting — Create a meeting for the authenticated user. A maximum of 100 meetings can be created per day.

Parameters

topic

string

Meeting topic

type

integer

Meeting type: 1 - Instant, 2 - Scheduled, 3 - Recurring no fixed time, 8 - Recurring fixed time

start_time

string

Meeting start time in yyyy-MM-ddTHH:mm:ssZ (GMT) or yyyy-MM-ddTHH:mm:ss (with timezone field). Used for scheduled/recurring meetings.

duration

integer

Meeting duration in minutes. Used for scheduled meetings only.

timezone

string

Time zone for start_time, e.g. America/Los_Angeles. For scheduled meetings only.

password

string

Password to join the meeting. May contain [a-z A-Z 0-9 @ - _ *], max 10 characters.

agenda

string

Meeting description/agenda

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "uuid": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Uuid"
    },
    "topic": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Topic"
    },
    "start_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start Time"
    },
    "join_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Join Url"
    },
    "password": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Password"
    },
    "start_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start Url"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateMeetingOutput",
  "type": "object"
}

list_meetings — List meetings for a user

Parameters

user_id

string

required

The user ID or email address of the user. Use ‘me’ for the current user.

type

string

Type of meetings to list: scheduled, live, upcoming, previous_meetings. Defaults to scheduled.

Response

{
  "$defs": {
    "MeetingWebinarItem": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "uuid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Uuid"
        },
        "topic": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Topic"
        },
        "type": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Type"
        },
        "start_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Start Time"
        },
        "duration": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Duration"
        },
        "timezone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Timezone"
        },
        "join_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Join Url"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        }
      },
      "title": "MeetingWebinarItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "meetings": {
      "items": {
        "$ref": "#/$defs/MeetingWebinarItem"
      },
      "title": "Meetings",
      "type": "array"
    },
    "total_records": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total Records"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListMeetingsOutput",
  "type": "object"
}

get_meeting_details — Retrieve the details of a meeting

Parameters

meeting_id

string

required

The meeting ID

occurrence_id

string

Meeting occurrence ID for recurring meetings

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "uuid": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Uuid"
    },
    "topic": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Topic"
    },
    "type": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Type"
    },
    "start_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start Time"
    },
    "duration": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Duration"
    },
    "timezone": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Timezone"
    },
    "join_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Join Url"
    },
    "password": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Password"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "host_email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Host Email"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetMeetingDetailsOutput",
  "type": "object"
}

update_meeting — Update an existing Zoom meeting's topic, time, or other settings

Parameters

meeting_id

string

required

The Zoom meeting ID to update

topic

string

Meeting topic

type

integer

Meeting type: 1 - Instant, 2 - Scheduled, 3 - Recurring no fixed time, 8 - Recurring fixed time

start_time

string

Meeting start time

duration

integer

Meeting duration in minutes

timezone

string

Time zone for start_time

password

string

Password to join the meeting, max 10 characters

agenda

string

Meeting description/agenda

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateMeetingOutput",
  "type": "object"
}

delete_meeting — Delete a meeting

Parameters

meeting_id

string

required

The ID of the meeting to delete

occurrence_id

string

If provided, only that occurrence will be deleted. Otherwise the entire meeting series is deleted.

schedule_for_reminder

boolean

If true, notify host and alternative host about the meeting cancellation via email

cancel_meeting_reminder

boolean

If true, notify registrants about the meeting cancellation via email

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteMeetingOutput",
  "type": "object"
}

get_current_user — Return the authenticated Zoom user's ID, name, email, account ID, and timezone

Response

{
  "$defs": {
    "UserInfo": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "first_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Name"
        },
        "last_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Name"
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Name"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email"
        },
        "account_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Account Id"
        },
        "timezone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Timezone"
        },
        "type": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Type"
        }
      },
      "title": "UserInfo",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "user": {
      "anyOf": [
        {
          "$ref": "#/$defs/UserInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetCurrentUserOutput",
  "type": "object"
}

send_chat_message — Send a chat message on Zoom to an individual contact or a channel

Parameters

message

string

required

The message to be sent

to_contact

string

The email address of the contact to send the message to

to_channel

string

The channel ID to send the message to

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendChatMessageOutput",
  "type": "object"
}

list_channels — List the authenticated user's chat channels

Parameters

page_size

integer

Number of records per page

next_page_token

string

Next page token for pagination. Expires after 15 minutes.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "channels": {
      "items": {
        "additionalProperties": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "type": "object"
      },
      "title": "Channels",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListChannelsOutput",
  "type": "object"
}

add_meeting_registrant — Register a participant for a meeting

Parameters

meeting_id

string

required

The meeting ID

string

required

A valid email address of the registrant

first_name

string

required

Registrant’s first name

last_name

string

required

Registrant’s last name

occurrence_ids

string

Occurrence IDs, multiple values separated by comma

Response

{
  "$defs": {
    "RegistrantResponse": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "registrant_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Registrant Id"
        },
        "start_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Start Time"
        },
        "join_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Join Url"
        },
        "topic": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Topic"
        }
      },
      "title": "RegistrantResponse",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "registrant": {
      "anyOf": [
        {
          "$ref": "#/$defs/RegistrantResponse"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "AddMeetingRegistrantOutput",
  "type": "object"
}

get_meeting_recordings — Get the recordings of a meeting

Parameters

meeting_id

string

required

The meeting ID to get recordings for

download_access_token

boolean

Whether to include a download access token in the response

Response

{
  "$defs": {
    "RecordingFile": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "meeting_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Meeting Id"
        },
        "recording_start": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Recording Start"
        },
        "recording_end": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Recording End"
        },
        "file_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Type"
        },
        "file_size": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Size"
        },
        "download_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Download Url"
        },
        "play_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Play Url"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "recording_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Recording Type"
        }
      },
      "title": "RecordingFile",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "recording_files": {
      "items": {
        "$ref": "#/$defs/RecordingFile"
      },
      "title": "Recording Files",
      "type": "array"
    },
    "download_access_token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Download Access Token"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetMeetingRecordingsOutput",
  "type": "object"
}

get_meeting_transcript — Get the transcript of a past meeting as speaker-attributed plain text

Parameters

meeting_id

string

required

The ID of a past meeting with cloud recording and audio transcription enabled

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "transcript_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Transcript Url"
    },
    "transcript_text": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Transcript Text"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetMeetingTranscriptOutput",
  "type": "object"
}

get_meeting_summary — Retrieve the AI-generated summary of a meeting or webinar

Parameters

meeting_id

string

required

The meeting ID or meeting UUID

Response

{
  "$defs": {
    "MeetingSummary": {
      "additionalProperties": false,
      "properties": {
        "meeting_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Meeting Id"
        },
        "meeting_uuid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Meeting Uuid"
        },
        "summary_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary Title"
        },
        "summary_overview": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary Overview"
        },
        "summary_details": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Summary Details"
        },
        "next_steps": {
          "items": {
            "type": "string"
          },
          "title": "Next Steps",
          "type": "array"
        }
      },
      "title": "MeetingSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "summary": {
      "anyOf": [
        {
          "$ref": "#/$defs/MeetingSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetMeetingSummaryOutput",
  "type": "object"
}

list_all_recordings — List all cloud recordings for a user

Parameters

user_id

string

The user ID or email. Use ‘me’ for the current user. (Default: me)

from_date

string

Start date in yyyy-MM-dd format. Maximum date range is one month.

to_date

string

End date in yyyy-MM-dd format

trash

boolean

If true, list recordings from trash

Response

{
  "$defs": {
    "RecordingFile": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "meeting_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Meeting Id"
        },
        "recording_start": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Recording Start"
        },
        "recording_end": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Recording End"
        },
        "file_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Type"
        },
        "file_size": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Size"
        },
        "download_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Download Url"
        },
        "play_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Play Url"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "recording_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Recording Type"
        }
      },
      "title": "RecordingFile",
      "type": "object"
    },
    "RecordingMeeting": {
      "additionalProperties": false,
      "properties": {
        "uuid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Uuid"
        },
        "id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "topic": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Topic"
        },
        "start_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Start Time"
        },
        "duration": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Duration"
        },
        "total_size": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Total Size"
        },
        "recording_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Recording Count"
        },
        "recording_files": {
          "items": {
            "$ref": "#/$defs/RecordingFile"
          },
          "title": "Recording Files",
          "type": "array"
        }
      },
      "title": "RecordingMeeting",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "meetings": {
      "items": {
        "$ref": "#/$defs/RecordingMeeting"
      },
      "title": "Meetings",
      "type": "array"
    },
    "total_records": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total Records"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListAllRecordingsOutput",
  "type": "object"
}

list_call_recordings — Get your account's Zoom Phone call recordings

Parameters

start_date

string

Start date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ format

end_date

string

End date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ format. Max 30-day range.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "recordings": {
      "items": {
        "additionalProperties": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "type": "object"
      },
      "title": "Recordings",
      "type": "array"
    },
    "total_records": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total Records"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListCallRecordingsOutput",
  "type": "object"
}

list_user_call_logs — Get a user's Zoom Phone call logs

Parameters

user_id

string

required

The user ID or email address of the user

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "call_logs": {
      "items": {
        "additionalProperties": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "type": "object"
      },
      "title": "Call Logs",
      "type": "array"
    },
    "total_records": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total Records"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListUserCallLogsOutput",
  "type": "object"
}

list_past_meeting_participants — Retrieve participants from a past meeting

Parameters

meeting_id

string

required

The meeting ID

Response

{
  "$defs": {
    "ParticipantItem": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "user_email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "User Email"
        },
        "join_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Join Time"
        },
        "leave_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Leave Time"
        },
        "duration": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Duration"
        }
      },
      "title": "ParticipantItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "participants": {
      "items": {
        "$ref": "#/$defs/ParticipantItem"
      },
      "title": "Participants",
      "type": "array"
    },
    "total_records": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total Records"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListPastMeetingParticipantsOutput",
  "type": "object"
}

create_user — Create a new user in your Zoom account

Parameters

action

string

required

How to create the user: create, autoCreate, custCreate, ssoCreate

string

required

User’s email address

type

integer

required

User type: 1 - Basic, 2 - Licensed, 3 - On-prem

first_name

string

User’s first name

last_name

string

User’s last name

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Email"
    },
    "first_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "First Name"
    },
    "last_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Last Name"
    },
    "type": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Type"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateUserOutput",
  "type": "object"
}

delete_user — Disassociate or permanently delete a user from the account

Parameters

user_id

string

required

The user ID or email address

action

string

Delete action: disassociate or delete

transfer_email

string

Email to transfer resources to

transfer_meeting

boolean

Transfer meetings to the transfer_email user

transfer_webinar

boolean

Transfer webinars to the transfer_email user

transfer_recording

boolean

Transfer recordings to the transfer_email user

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteUserOutput",
  "type": "object"
}

get_webinar_details — Get details of a scheduled webinar

Parameters

webinar_id

string

required

The webinar ID

occurrence_id

string

Unique identifier for an occurrence of a recurring webinar

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "uuid": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Uuid"
    },
    "topic": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Topic"
    },
    "type": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Type"
    },
    "start_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start Time"
    },
    "duration": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Duration"
    },
    "timezone": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Timezone"
    },
    "join_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Join Url"
    },
    "host_email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Host Email"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetWebinarDetailsOutput",
  "type": "object"
}

update_webinar — Update a webinar's topic, start time, or other settings

Parameters

webinar_id

string

required

The Zoom webinar ID to update

topic

string

Webinar topic

type

integer

Webinar type: 5 - Webinar, 6 - Recurring no fixed time, 9 - Recurring fixed time

start_time

string

Webinar start time

duration

integer

Webinar duration in minutes

timezone

string

Time zone for start_time

password

string

Password to join the webinar, max 10 characters

agenda

string

Webinar description/agenda

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateWebinarOutput",
  "type": "object"
}

add_webinar_registrant — Register a participant for a webinar

Parameters

webinar_id

string

required

The webinar ID

string

required

A valid email address of the registrant

first_name

string

required

Registrant’s first name

last_name

string

required

Registrant’s last name

occurrence_ids

string

Occurrence IDs, multiple values separated by comma

Response

{
  "$defs": {
    "RegistrantResponse": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "registrant_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Registrant Id"
        },
        "start_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Start Time"
        },
        "join_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Join Url"
        },
        "topic": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Topic"
        }
      },
      "title": "RegistrantResponse",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "registrant": {
      "anyOf": [
        {
          "$ref": "#/$defs/RegistrantResponse"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "AddWebinarRegistrantOutput",
  "type": "object"
}

list_webinar_participants_report — Retrieve detailed report on each webinar attendee. Reports available for the last 6 months.

Parameters

webinar_id

string

required

The webinar ID

Response

{
  "$defs": {
    "ParticipantItem": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "user_email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "User Email"
        },
        "join_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Join Time"
        },
        "leave_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Leave Time"
        },
        "duration": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Duration"
        }
      },
      "title": "ParticipantItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "participants": {
      "items": {
        "$ref": "#/$defs/ParticipantItem"
      },
      "title": "Participants",
      "type": "array"
    },
    "total_records": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total Records"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListWebinarParticipantsReportOutput",
  "type": "object"
}

list_past_webinar_qa — List Q&A from a past webinar

Parameters

webinar_id

string

required

The Zoom webinar ID

Response

{
  "$defs": {
    "QaItem": {
      "additionalProperties": false,
      "properties": {
        "question": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Question"
        },
        "answer": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Answer"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email"
        }
      },
      "title": "QaItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "questions": {
      "items": {
        "$ref": "#/$defs/QaItem"
      },
      "title": "Questions",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListPastWebinarQaOutput",
  "type": "object"
}

Limits & Quotas

Rate limits: Zoom enforces per-second and daily rate limits that vary by plan and endpoint. Typical limits are 10 requests/second for most endpoints.
Meeting creation: Maximum 100 meetings per user per day.
Recordings: Cloud recording storage depends on the plan tier.
Reports: Webinar participant reports are available for the last 6 months only.
Error model: Non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

​Overview

​Authentication

​OAuth2 Authentication

​Required Credentials

​OAuth Configuration

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Google Meet

Microsoft Teams

AgentMail

​Links

Overview

Authentication

OAuth2 Authentication

Required Credentials

OAuth Configuration

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links