Get All Room Admins
- Print
- DarkLight
- PDF
Get All Room Admins
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/rooms.adminRooms
Retrieves all rooms and admin information.
Permission required: view-room-administration
Changelog
| Version | Description |
|---|---|
| 2.4.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
types
array of string
The room types. The possible room types are:
d: Direct messagesc: Public channelp: Private channeldiscussions: Team or channel discussionsteams: Workspace teamsl: Livechatv: Omnichannel VoIP rooms
filter
string
The rooms name
count
integer
The number of items to return.
Example50
sort
List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
Example50
Responses
200
OK
Success
{
"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
}object
rooms
Array of object
object
_id
string
fname
string
description
string
broadcast
boolean
federated
boolean
name
string
t
string
msgs
integer
usersCount
integer
u
object
_id
string
username
string
ro
boolean
default
boolean
topic
string
announcement
string
count
integer
offset
integer
total
integer
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?