Search public rooms

Search for federated public rooms by the server name or room name.

Path Variables

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/federation/searchPublicRooms?serverName=matrix.org

Example Result

{
    "rooms": [
        {
            "id": "!OGEhHVWSdvArJzumhm:matrix.org",
            "name": "Matrix HQ",
            "canJoin": true,
            "canonicalAlias": "#matrix:matrix.org",
            "joinedMembers": 44461,
            "topic": "The Official Matrix HQ - chat about Matrix here! | https://matrix.org | https://spec.matrix.org | To support Matrix.org development: https://patreon.com/matrixdotorg | Code of Conduct: https://matrix.org/legal/code-of-conduct/ | This is an English speaking room"
        }
    ],
    "count": 1,
    "total": 73080,
    "nextPageToken": "g6FtzZa3oXK+IUpkemFiTlVQUFh6bENKQWhFbDpmYWJyaWMucHVioWTD",
    "prevPageToken": "g6FtzYqIoXK+IWNOd2pkUXdWcFJNc0lNa1VweDptYXRyaXgub3JnoWTC",
    "success": true
}

Last updated

Rocket.Chat versions receive support for six months after release.