Reference
Fuselage
Channel List
Lists all of the channels on the server. It supports the Offset, Count, and Sort Query Parameters along with Query and Fields Query Parameters.
URL
Requires Auth
HTTP Method
/api/v1/channels.list
yes
GET

Example Call

1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
http://localhost:3000/api/v1/channels.list
Copied!

Example Result

1
{
2
"channels": [
3
{
4
"_id": "ByehQjC44FwMeiLbX",
5
"name": "test-test",
6
"t": "c",
7
"usernames": [
8
"testing1"
9
],
10
"msgs": 0,
11
"u": {
12
"_id": "aobEdbYhXfu5hkeqG",
13
"username": "testing1"
14
},
15
"ts": "2016-12-09T15:08:58.042Z",
16
"ro": false,
17
"sysMes": true,
18
"_updatedAt": "2016-12-09T15:22:40.656Z"
19
},
20
{
21
"_id": "t7qapfhZjANMRAi5w",
22
"name": "testing",
23
"t": "c",
24
"usernames": [
25
"testing2"
26
],
27
"msgs": 0,
28
"u": {
29
"_id": "y65tAmHs93aDChMWu",
30
"username": "testing2"
31
},
32
"ts": "2016-12-01T15:08:58.042Z",
33
"ro": false,
34
"sysMes": true,
35
"_updatedAt": "2016-12-09T15:22:40.656Z"
36
}
37
],
38
"offset": 0,
39
"count": 1,
40
"total": 1,
41
"success": true
42
}
Copied!

Change Log

Version
Description
0.49.0
Count and offset query parameters supported.
0.48.0
Added
Last modified 8mo ago
Export as PDF
Copy link
Edit on GitHub