Get All Room Admins

Retrieves all rooms and admin information.

HTTP Method	URL	Requires Auth
GET	/api/v1/rooms.adminRooms	yes

Permission required: view-room-administration

Query Parameters

This endpoint supports the Pagination parameters. Additional parameters are as follows:

Key	Example Value	Description
types	c	The room types. The possible room types are: d: Direct messages c: Public channel p: Private channel discussions: Team or channel discussions teams: Workspace teams l: Livechat v: Omnichannel VoIP rooms
filter	general	The rooms's name.

Example Call

curl -H "X-Auth-Token: ijFlJ1yfidXhwEYY284Anoq_iEsOeMMVCupzNhX22tB" \
     -H "X-User-Id: hw5DThnhQmxDWnavu" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/rooms.adminRooms?types[]=c&types[]=p&filter=GENERAL

Example Response

{
    "rooms": [
        {
            "_id": "654c9d1ca2f73c7460e1918b",
            "fname": "animalGeography",
            "topic": "",
            "broadcast": false,
            "name": "animalGeography",
            "t": "p",
            "msgs": 4,
            "usersCount": 1,
            "u": {
                "_id": "CkCPNcvsvCDfmWLqC",
                "username": "kim.jane",
                "name": "kim.jane"
            },
            "ro": false,
            "default": false
        }
    ],
    "count": 1,
    "offset": 0,
    "total": 1,
    "success": true
}

Change Log

Version	Description
2.4.0	Added