View as Markdown
Zoom Admin icon

Zoom Admin ACTION

List users

List all users. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Zoom Admin account once, then configure and run List users from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "zoom_admin-list-users",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zoom_admin: { authProvisionId: "apn_xxxxxxx" },
    status: "Status",
    pageSize: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List users inputs
Property Type Description
status Status string
The user's status
Optional
pageSize Page Size integer
The number of records returned within a single API call
Optional
roleId Role ID string
The role's unique ID to filter users by a specific role
Optional
pageNumber Page Number string
The page number of the current page in the returned records
Optional
includeFields Include Fields string
Additional fields to include in the response
Optional
nextPageToken Next Page Token string
Token for paginating through large result sets (expires in 15 minutes)
Optional
license License string
Filter users by specific license
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
zoom_admin-list-users
Version
0.0.3
App
Zoom Admin
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes