Fuselage
Get Rooms
REST API Get Methods
Get all opened rooms (all joined public & private channels and all DMs) for this user.
URL
Requires Auth
HTTP Method
/api/v1/rooms.get
yes
GET

Query Parameters

Argument
Example
Required
Description
updatedSince
2017-11-25T15:08:17.248Z
Optional
Date as ISO string
When you provide the updatedSince query parameter in the URL then the update and remove in the response will contain only those updated and removed since this date and time.

Example Call to get all of the rooms

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.get
Copied!

Example Result

1
{
2
"update": [
3
{
4
"_id": "GENERAL",
5
"name": "general",
6
"t": "c",
7
"_updatedAt": "2018-01-21T21:03:43.736Z",
8
"default": true
9
},
10
{
11
"_id": "3WpJQkDHhrWPBvXuWhw5DThnhQmxDWnavu",
12
"t": "d",
13
"_updatedAt": "2018-01-21T21:07:16.123Z"
14
},
15
{
16
"_id": "hw5DThnhQmxDWnavurocket.cat",
17
"t": "d",
18
"_updatedAt": "2018-01-21T21:07:18.510Z"
19
},
20
{
21
"_id": "hw5DThnhQmxDWnavuhw5DThnhQmxDWnavu",
22
"t": "d",
23
"_updatedAt": "2018-01-21T21:07:20.324Z"
24
},
25
{
26
"_id": "EAemRsye7khfr9Stt",
27
"name": "123",
28
"fname": "123",
29
"t": "p",
30
"u": {
31
"_id": "hw5DThnhQmxDWnavu",
32
"username": "user2"
33
},
34
"_updatedAt": "2018-01-24T21:02:04.318Z",
35
"customFields": {},
36
"ro": false
37
}
38
],
39
"remove": [],
40
"success": true
41
}
Copied!

Example Call to get the rooms which have changed after the provided date

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.get?updatedSince=2018-01-26T00:11:22.345Z
Copied!

Example Result

1
{
2
"update": [
3
{
4
"_id": "GENERAL",
5
"name": "general",
6
"t": "c",
7
"_updatedAt": "2018-01-27T16:14:15.379Z",
8
"default": true
9
}
10
],
11
"remove": [],
12
"success": true
13
}
Copied!

Change Log

Version
Description
0.62.0
Added
Last modified 8mo ago