List Users

zulip.get_users

ActionChat & messagingconnection required

Calls the Zulip API with the connection's credentials.

Read every user in the organization.

Ask about Zulip All Zulip nodes Provider API docs ↗

Connection

Required: Yes — the node will not save without one
Auth type: Username & password
Providers: Zulip
Secret shape: {"email": "…", "api_key": "…"} — HTTP Basic, email as the username
Config it needs: base_url
Resolved by: config.connection_id, else node.connection_id

Configuration

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

Field	Type	Required	Default	Constraints	Example
include_custom_profile_fields Include the organization's custom profile fields on each user.	boolean	No	false	—	—

Example configuration

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

{
  "include_custom_profile_fields": false
}

Output

One shape.

result

Field	Type	Example
items The records Zulip returned.	array	—
count How many records this response carried.	number	—
items[].user_id The user id.	number	—
items[].email The user's email address as this account may see it.	string	—
items[].full_name The user's display name.	string	—
items[].is_active True when the account has not been deactivated.	boolean	—
items[].is_bot True when the account is a bot.	boolean	—
items[].is_admin True when the user is an organization administrator.	boolean	—
items[].role The user's role code, as Zulip defines it.	number	—
items[].avatar_url URL of the user's avatar, when one is available.	string	—
items[].timezone The user's configured time zone.	string	—
items[].date_joined When the account was created, as an ISO-8601 timestamp.	string	—

{
  "count": 0,
  "items": [
    {
      "avatar_url": "",
      "date_joined": "",
      "email": "",
      "full_name": "",
      "is_active": false,
      "is_admin": false,
      "is_bot": false,
      "role": 0,
      "timezone": "",
      "user_id": 0
    }
  ]
}

Related Zulip nodes

See List Users run in a workflow.

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

Book a technical demo Talk to sales