Get User

zulip.get_user
ActionChat & messagingconnection required

Calls the Zulip API with the connection's credentials.

Read one user's profile by id.

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

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

FieldTypeRequiredDefaultConstraintsExample
user_id
The user to read, as a Zulip user id.
stringYes——10
include_custom_profile_fields
Include the organization's custom profile fields on each user.
booleanNofalse——

Example configuration

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

{
  "include_custom_profile_fields": false,
  "user_id": "10"
}

Output

One shape.

result

FieldTypeExample
user_id
The user id.
number—
email
The user's email address as this account may see it.
string—
full_name
The user's display name.
string—
is_active
True when the account has not been deactivated.
boolean—
is_bot
True when the account is a bot.
boolean—
is_admin
True when the user is an organization administrator.
boolean—
role
The user's role code, as Zulip defines it.
number—
avatar_url
URL of the user's avatar, when one is available.
string—
timezone
The user's configured time zone.
string—
date_joined
When the account was created, as an ISO-8601 timestamp.
string—
{
  "avatar_url": "",
  "date_joined": "",
  "email": "",
  "full_name": "",
  "is_active": false,
  "is_admin": false,
  "is_bot": false,
  "role": 0,
  "timezone": "",
  "user_id": 0
}

See Get User 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.