ETetkecc
matrix-cs

Room summary

Changed on

Room summary (name, topic, member count, join rules) for a room ID or alias, per MSC3266. We answer this for rooms we have crawled, so it works even though we are a search index and not the room's homeserver. Registered at the stable v1 path plus the two unstable im.nheko.summary paths, because matrix.to and older clients still call those.

get/_matrix/client/v1/room_summary/{room_id_alias}

Request

Path parameters

room_id_aliasstring required

Room ID or alias to summarize

Query parameters

viastring

A server to try for the summary if we do not hold the room locally. Only the first value is used.

Response

Room summary

avatar_urlstring
canonical_aliasstring
guest_can_joinboolean
join_rulestring
namestring
num_joined_membersinteger
room_idstring
room_typestring
topicstring
world_readableboolean

Changes