- Print
- DarkLight
- PDF
List Group Members
- Print
- DarkLight
- PDF
Lists the members of a private group.
Permission required if the room is broadcast.: view-broadcast-member-list
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.
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}
The number of items to return.
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
The user's status (search filter).
Extra search filters to be applied to the fields defined in the Accounts_SearchFields
setting.
OK
{
"members": [
{
"_id": "Q4GkX6RMepGDdQ7YJ",
"status": "online",
"name": "Marc Pow",
"utcOffset": -3,
"username": "marc.pow"
},
{
"_id": "rocket.cat",
"name": "Rocket.Cat",
"username": "rocket.cat",
"status": "online",
"utcOffset": 0
}
],
"count": 2,
"offset": 0,
"total": 2,
"success": true
}
Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}