Lists all channel users. The list of elements a user can use to sort the list is limited. The current sortable element is: username.
If the channel is a broadcast channel, you need the view-broadcast-member-list permission.
Changelog
| Version | Description |
|---|---|
| 0.59.0 | Added |
The authToken of the authenticated user.
The userId of the authenticated user.
The room ID. It is required if the roomName is not provided.
The room name. It is required if the roomId is not provided.
The user's status (search filter).
Extra search filters to be applied to the fields defined in the Accounts_SearchFieldssetting.
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}. Refer to the official documentation to learn more.
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.
OK
{
"members": [
{
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"status": "offline",
"_updatedAt": "2023-09-24T22:27:33.610Z",
"name": "test test",
"nickname": "baby girl"
},
{
"_id": "5fRTXMt7DMJbpPJfh",
"username": "test.test",
"status": "offline",
"_updatedAt": "2023-09-16T08:33:38.123Z",
"name": "Testtest",
"avatarETag": "GFoEi6wv3uAxnzDcD",
"nickname": "test.test"
}
],
"count": 2,
"offset": 0,
"total": 2,
"success": true
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}