Audit Rooms
- Print
- DarkLight
- PDF
Audit Rooms
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/audit/rooms.members
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 |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
roomId
stringRequired
Enter the room ID that you want to audit.
Example66cd971f6fcbb8e8b3cf8e69
filter
string
Filter the results using the text that you want to view.
count
integer
The number of items to return.
Example50
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
Example50
sort
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}
Responses
200
OK
Example 1
{
"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
}object
members
Array of object
object
_id
string
status
string
name
string
username
string
_updatedAt
string
count
integer
offset
integer
total
integer
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'roomId' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}object
success
boolean
error
string
Was this article helpful?