Links
Comment on page

List Rooms of a team

List all rooms of the team. It supports only the offset and count parameter for Pagination.
URL
Requires Auth
HTTP Method
/api/v1/teams.listRooms
yes
GET

Query Parameters

Argument
Example
Required
Description
teamId teamName
ByehQjC44FwMeiLbX team1
Required
The team id. The team name.
filter
Example Room Name
Optional
The room's name (search filter).
type
autoJoin
Optional
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" \
'http://localhost:3000/api/v1/teams.listRooms?teamName=team1&type=autoJoin'

Example Result

{
"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 modified 5mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.