Audit any public or private room and view the room members. You don't need to be a member of the room.
Permission required: view-members-list-all-rooms
Changelog
| Version | Description |
|---|---|
| 6.12.0 | Added |
The authToken of the authenticated user.
The userId of the authenticated user.
Enter the room ID that you want to audit.
Filter the results using the text that you want to view.
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.
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.
OK
{
"members": [
{
"_id": "FSA63o85Poa2EQvAH",
"status": "offline",
"name": "cat kate",
"username": "cat.kate",
"_updatedAt": "2024-08-27T09:07:03.795Z"
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}Bad Request
{
"success": false,
"error": "must have required property 'roomId' [invalid-params]",
"errorType": "invalid-params"
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}Forbidden
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}