List Rooms of a Team

List all rooms of the team.

HTTP MethodURLRequires Auth



Query Parameters

This endpoint supports the offset and count parameter forPagination parameters.

KeyExample ValueDescription

teamId* or teamName*

ByehQjC44FwMeiLbX or team1

The team ID or the team name. You must enter either one of these parameters.


Example Room Name

The room's name (search filter).



The room's type (search filter).

Example Call

curl  -H 'X-Auth-Token: _2u_4MzRroRcnqc59GYUY_Kwgr9HgtZ9HCKn-2aIvMJ' \
      -H 'X-User-Id: FL2fZL4ERhwA3gWiS' \
      -H "Content-type: application/json" \

Example Response

  "rooms": [
      "_id": "8Z7eRsibvD5AANfmK",
      "name": "channelAutoJoin",
      "fname": "channelAutoJoin",
      "t": "c",
      "msgs": 7,
      "usersCount": 1,
      "u": {
        "_id": "FL2fZL4ERhwA3gWiS",
        "username": "some.username"
      "customFields": {},
      "description": "",
      "broadcast": false,
      "encrypted": false,
      "ts": "2021-04-27T19:59:07.258Z",
      "ro": false,
      "_updatedAt": "2021-04-28T20:57:18.362Z",
      "teamId": "607e0d9b49d493189836bfac",
      "teamDefault": true
  "total": 1,
  "count": 1,
  "offset": 0,
  "success": true

Last updated

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