Get User Info
rocketchat.get_user_info
ActionChat & messagingconnection required
Calls the Rocket.Chat API with the connection's credentials.
Look up one user by id, username or email address — the step that turns a person into the user id and username the messaging ops use.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Rocket.Chat
- Secret shape
- the personal access token, or {"token": "…", "user_id": "…"}
- Config it needs
- base_url, user_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 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 |
|---|---|---|---|---|---|
user_id Look the user up by id. | string | No | — | — | — |
username Look the user up by username. | string | No | — | — | — |
email Look the user up by email address. | string | No | — | email format | — |
- At least one of user_id, username, email must be set.
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
user._id The user's id. | string | — |
user.username The user's username. | string | jane.doe |
user.name The user's display name. | string | — |
user.status online, away, busy or offline. | string | — |
user.active Whether the account is active. | boolean | — |
user.roles The user's role names. | array | — |
success True — Rocket.Chat's own envelope flag. | boolean | — |
{
"success": false,
"user": {
"_id": "",
"active": false,
"name": "",
"roles": [],
"status": "",
"username": "jane.doe"
}
}See Get User Info run in a workflow.
In a technical demo we add the Rocket.Chat connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.