List meeting registrants with the Zoom API

Lists the registrants of a meeting with registration turned on. Only approved registrants come back unless status says otherwise. Needs a Pro plan or higher. Pass next_page_token to read the next page.

Identifier
zoom_list_meeting_registrants

The request

POST https://connect.reportei.com/api/tools/zoom_list_meeting_registrants/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "meetingId": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
meetingIdintegerYesMeeting ID, from List meetings.
statusstringNoRegistration status. The default is approved.Values: pending, approved, denied
occurrence_idstringNoOne occurrence of a recurring meeting, from the occurrences in Get meeting.
page_sizeintegerNoRegistrants per page, up to 300. The default is 30.
next_page_tokenstringNoThe next_page_token of the previous response.

Supported connections

Your customer connects their Zoom account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/zoom, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/zoom_list_meeting_registrants. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.