---
title: "Room summary"
method: GET
path: "/_matrix/client/unstable/im.nheko.summary/summary/{room_id_alias}"
tags: ["matrix-cs"]
---

# Room summary

`GET /_matrix/client/unstable/im.nheko.summary/summary/{room_id_alias}`

## Request

- The document declares no server URL.
- Auth: none declared
- TypeScript: <https://skmtc.dev/etkecc/apis/matrix-rooms-search-api/docs/_matrix/client/unstable/im.nheko.summary/summary/:room_id_alias/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `room_id_alias` string, required

## Query parameters

- `via` string

## Response `200`

Room summary

- GithubComEtkeccMrsInternalModelRoomDirectoryRoom
  - `avatar_url` string
  - `canonical_alias` string
  - `guest_can_join` boolean
  - `join_rule` string
  - `name` string
  - `num_joined_members` integer
  - `room_id` string
  - `room_type` string
  - `topic` string
  - `world_readable` boolean

## Other responses

- `404`: Room not found

## Changes

- **2026-07-08** `ae3c2fd65492`: 1 info
  - endpoint added
- **2024-08-20** `4009b08a3a5a`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/etkecc/apis/matrix-rooms-search-api/changes/_matrix/client/unstable/im.nheko.summary/summary/:room_id_alias/get.md)

---

[API](https://skmtc.dev/etkecc/apis/matrix-rooms-search-api.md) - [All operations](https://skmtc.dev/etkecc/apis/matrix-rooms-search-api/llms.txt) - [OpenAPI document](https://skmtc.dev/etkecc/apis/matrix-rooms-search-api/revisions/fafe2e40cd8c?raw)