Fuselage
Admin Rooms
REST API Admin Rooms Methods
Retrieves all rooms (requires the view-room-administration permission). It supports the Offset, Count, and Sort Query Parameters.
URL
Requires Auth
HTTP Method
/api/v1/rooms.adminRooms
yes
GET

Query Parameters

Argument
Example
Required
Description
types
['c']
Optional (must be an array)
The rooms types
filter
general
Optional
The rooms's name

Example

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

Example Result

1
{
2
"rooms": [
3
{
4
"_id": "GENERAL",
5
"t": "c",
6
"name": "general",
7
"usernames": [],
8
"msgs": 98,
9
"usersCount": 38,
10
"default": true
11
},
12
],
13
"count": 1,
14
"offset": 0,
15
"total": 88,
16
"success": true
17
}
Copied!

Change Log

Version
Description
2.4.0
Added
Last modified 8mo ago
Export as PDF
Copy link
Edit on GitHub