---
title: "Get a list of local aliases on a given room."
method: GET
path: "/_matrix/client/v3/rooms/{roomId}/aliases"
tags: ["Room directory"]
---

# Get a list of local aliases on a given room.

`GET /_matrix/client/v3/rooms/{roomId}/aliases`

## Request

- Base URL: `https://matrix.org`
- URL: `https://matrix.org/_matrix/client/v3/rooms/{roomId}/aliases`
- Auth: one of:
  - API key in query parameter `access_token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/rooms/:roomId/aliases/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `roomId` string, mx-room-id, required

## Response `200`

The list of local aliases for the room.

- object
  - `aliases` string[], required: The server's local aliases on the room. Can be empty.

## Other responses

- `400`: The given `roomAlias` is not a valid room alias.
- `403`: The user is not permitted to retrieve the list of local aliases for the room.
- `429`: This request was rate-limited.

---

[API](https://skmtc.dev/matrix/apis/matrix-client-server-api.md) - [All operations](https://skmtc.dev/matrix/apis/matrix-client-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/matrix/apis/matrix-client-server-api/revisions/c7fe4072c681?raw)