Get Profile
matrix.get_profile
ActionChat & messagingconnection required
Calls the Matrix API with the connection's credentials.
Read a user's display name and avatar from their profile.
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
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 |
|---|---|---|---|---|---|
user_id The user to look up; defaults to the connection's own account. | string | No | — | — | @jane:example.org |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"user_id": "@jane:example.org"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
user_id The user the profile belongs to. | string | — |
displayname The display name, when the user has set one. | string | — |
avatar_url The avatar's mxc:// URI, when set. | string | — |
{
"avatar_url": "",
"displayname": "",
"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 Get Profile 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.