List Room Members
matrix.list_room_members
ActionChat & messagingconnection required
Calls the Matrix API with the connection's credentials.
List a room's membership events, optionally filtered by membership state.
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
4 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 |
|---|---|---|---|---|---|
room_id The room id, e.g. !AbCdEf:example.org — resolve a #alias:server with matrix.resolve_room_alias first. | string | Yes | — | — | !AbCdEf:example.org |
membership Only return members in this membership state. | string | No | — | one of "join", "invite", "knock", "leave", "ban" | — |
not_membership Exclude members in this membership state. | string | No | — | one of "join", "invite", "knock", "leave", "ban" | — |
at A pagination token from a sync or messages call: return the membership as it was at that point in the timeline. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"room_id": "!AbCdEf:example.org"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The m.room.member events that matched. | array | — |
items[].state_key The member's user id. | string | — |
items[].content.membership join, invite, leave, ban or knock. | string | — |
count How many member events were returned. | number | — |
{
"count": 0,
"items": [
{
"content": {
"membership": ""
},
"state_key": ""
}
]
}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 List Room Members 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.