Get
/api/v1/audit.auditions
Lists the audit searches performed during a specified period. This endpoint requires a license that includes the auditing module. Dates use ISO 8601 format. Requests are limited to ten per minute.
This endpoint replaces the deprecated auditGetAuditions real-time method, which remains available until 9.0.0.
Permission required:
can-audit-log
Changelog
| Version | Description |
|---|---|
| 8.8.0 | Added |
Header parameters
X-User-Id
stringRequired
The user ID.
ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired
The authentication token.
Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Query parameters
startDate
string (date-time) Required
The beginning of the period to list, as an ISO date string.
Example2026-08-01T00:00:00Z
endDate
string (date-time) Required
The end of the period to list, as an ISO date string.
Example2026-08-20T23:59:59.999Z
Responses
200
OK
Success Example
{
"auditions": [],
"success": true
}object
auditions
Array of object
The audit log entries recorded in the requested period.
object
_id
string
_updatedAt
string (date-time)
ts
string (date-time)
results
number
u
object
_id
string
username
string
name
string
avatarETag
string
fields
object
type
string
msg
string | null
startDate
string (date-time) | null
endDate
string (date-time) | null
rids
Array of string | null
string
room
string | null
users
Array of string | null
string
visitor
string | null
agent
string | null
filters
string | null
success
boolean
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