Room directory

Get a list of local aliases on a given room.

Get a list of aliases maintained by the local server for the given room.

This endpoint can be called by users who are in the room (external users receive an M_FORBIDDEN error response). If the room's m.room.history_visibility maps to world_readable, any user can call this endpoint.

Servers may choose to implement additional access control checks here, such as allowing server administrators to view aliases regardless of membership.

Note: Clients are recommended not to display this list of aliases prominently as they are not curated, unlike those listed in the m.room.canonical_alias state event.

get/_matrix/client/v3/rooms/{roomId}/aliases

Request

Path parameters

roomIdstring mx-room-id required

The room ID to find local aliases of.

Response

The list of local aliases for the room.

aliasesstring[] required

The server's local aliases on the room. Can be empty.

Changes

No recorded changes to this operation across all 1 revision of this API.