Reference
Fuselage
Channel Members List
Lists all channel users. It supports the Offset, Count, and Sort Query Parameters.
The list of elements a user can use to sort the list is limited. The current sortable element is:username
URL
Requires Auth
HTTP Method
/api/v1/channels.members
yes
GET

Query Parameters

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required (if no roomName)
The channel's id
roomName
general
Required (if no roomId)
The channel's name

Example Call

1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
http://localhost:3000/api/v1/channels.members?roomId=ByehQjC44FwMeiLbX&count=2
Copied!

Example Result

1
{
2
"members": [
3
{
4
"_id": "Loz7qh9ChSqHMPymx",
5
"username": "customField_apiuser.test.1529436896005",
6
"name": "customField_apiuser.test.1529436896005",
7
"status": "offline"
8
},
9
{
10
"_id": "Zc3Y3cRW7ZtS7Y8Hk",
11
"username": "customField_apiuser.test.1529436997563",
12
"name": "customField_apiuser.test.1529436997563",
13
"status": "offline"
14
}
15
],
16
"count": 2,
17
"offset": 0,
18
"total": 35,
19
"success": true
20
}
Copied!

Change Log

Version
Description
0.59.0
Added
Last modified 7mo ago
Export as PDF
Copy link
Edit on GitHub