Book a demo

List Users

zoom.list_users
ActionChat & messagingconnection required

Calls the Zoom API with the connection's credentials.

Page through the users on the Zoom account, by status.

Ask about ZoomAll Zoom nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
OAuth 2.0
Providers
Zoom
Secret shape
{"account_id", "client_id", "client_secret"} — Server-to-Server OAuth
Config it needs
account_id
Resolved by
config.connection_id, else node.connection_id

Configuration

4 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
status
Which users to list. 'pending' are invited but have not accepted.
stringNoactiveone of "active", "inactive", "pending"—
role_id
Only users holding this role id. Leave blank for all roles.
stringNo———
page_size
How many rows to return on this page (1-2000).
numberNo301–2000—
next_page_token
The next_page_token from a previous page. Expires after 15 minutes.
stringNo———

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "page_size": 30,
  "status": "active"
}

Output

One shape.

result

FieldTypeExample
users[].id
The Zoom user id.
string—
users[].email
The user's email address.
string—
users[].first_name
The user's first name.
string—
users[].last_name
The user's last name.
string—
users[].display_name
The name shown in meetings.
string—
users[].type
1 basic, 2 licensed, 99 none (on-prem).
number—
users[].status
active, inactive or pending.
string—
users[].role_id
The account role the user holds.
string—
users[].timezone
The user's timezone, e.g. Europe/London.
string—
users[].pmi
The user's personal meeting id, as a string.
string—
users[].dept
The department on the user's profile.
string—
count
How many rows this page carries.
number—
next_page_token
Token for the next page, or empty when done. Expires after 15 minutes.
string—
total_records
How many records Zoom reports across all pages.
number—
page_size
The page size Zoom actually applied.
number—
{
  "count": 0,
  "next_page_token": "",
  "page_size": 0,
  "total_records": 0,
  "users": [
    {
      "dept": "",
      "display_name": "",
      "email": "",
      "first_name": "",
      "id": "",
      "last_name": "",
      "pmi": "",
      "role_id": "",
      "status": "",
      "timezone": "",
      "type": 0
    }
  ]
}

Notes

  • Only 'active' users are listed unless status says otherwise, so a user who has been deactivated will not appear in the default listing.

Related Zoom nodes

See List Users run in a workflow.

In a technical demo we add the Zoom connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales