Search Users
matrix.search_users
ActionChat & messagingconnection required
Calls the Matrix API with the connection's credentials.
Search the homeserver's user directory by name or user id.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Matrix
- Secret shape
- the account access token, or {"access_token": "…"}
- Config it needs
- base_url, user_id, default_room_id
- 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.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
search_term Text to match against display names and user ids. | string | Yes | — | — | — |
limit How many users to return; the homeserver defaults to 10. | number | No | — | ≥ 1 | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
results The matching users. | array | — |
results[].user_id The user's Matrix id. | string | — |
results[].display_name The user's display name. | string | — |
results[].avatar_url The user's avatar mxc:// URI. | string | — |
limited True when the homeserver truncated the results. | boolean | — |
count How many users were returned. | number | — |
{
"count": 0,
"limited": false,
"results": [
{
"avatar_url": "",
"display_name": "",
"user_id": ""
}
]
}Notes
- The connection's base_url is the homeserver (e.g. https://matrix.example.org), not the account's server name; the two differ whenever .well-known delegation is in use.
- Rooms are addressed by room id (!abc:server). Resolve a #alias:server with matrix.resolve_room_alias first, or set a default room on the connection.
See Search Users run in a workflow.
In a technical demo we add the Matrix connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.