v1

latestSwagger 2.0AGPL-3.02026-07-17413281.9 KB
catalog

Room preview

Room preview by ID or alias: like the Matrix client-server room preview, but enriched with everything MRS knows about a room (language and so on). We try our own index first, then fall back to a live MSC3266 summary, and when that fallback fires we set the X-MRS-MSC3266: true response header so you can tell. Marked EXPERIMENT in the source, so treat the shape as not yet frozen.

get/room/{room_id_or_alias}

Path parameters

room_id_or_aliasstring required

Room ID or alias

Query parameters

viastring

Server to try for the MSC3266 fallback if we do not have the room indexed

Response

Room data

avatar_urlstring
avatar_url_httpstring
canonical_aliasstring
emailstring
guest_can_joinboolean
join_rulestring
languagestring
namestring
num_joined_membersinteger
parsed_atstring
room_idstring
room_typestring
serverstring

Parsed (custom) fields

serversstring[]
topicstring
world_readableboolean