List Users
List workspace users, optionally filtered by role.
Type
user.listFolder
userChannels
Any
Pipe
Value
Scope
Any
List Users returns members of the current workspace. Optionally Filter by roles: anyone with any of the selected roles is included. Parent and child roles are independent. Leave the filter empty to list all members.
The built-in Vettero agent user is omitted. Results are workspace members, not chat visitors.
Configure
| Setting | Description |
|---|---|
| Filter by roles | Optional role tree. Empty means all workspace members |
Handles
| Handle | Role |
|---|---|
| In (target) | Incoming connection |
| Out (source) | Continues after the list is loaded |
Pipe schema
The next block reads this on the data pipe (pipe.value):
| Key | Type | Description |
|---|---|---|
users | list | Matching members |
Each user includes:
| Key | Type | Description |
|---|---|---|
id | text | User id |
name | text | Display name |
username | text | Username |
email | text | |
avatar | text | Avatar URL when set |
isOwner | boolean | Workspace owner |
isDeveloper | boolean | Workspace developer |
roleIds | list of text | Workspace role ids |
Use case
- Loop with For Of and send a notification to each member in a role.
- Build an assignee list for a table User column.