# Reading audit logs Admin only Paginated

To read the audit logs generated for your realm, use the following endpoint

GET /api/audit

On success the response will be the default paginated API response with the data being a data array of log entries.

The log entries will be in the following format:

[
    {
        "id": "string",
        "date": "2023-12-15T18:48:28.775Z",
        "event": "string",
        "properties": "string",
        "realm": 0,
        "user": 0 | null,
        "client": "string" | null,
    }
]

The following keys are supported for the sort parameter:

Key Description
date Sort by the date of the log entry

The following keys are supported for the filter parameter:

Key Desciption Example Value
event Filter by whether the entry is for a certain event "admin_login,client_update" (Comma seperated)
minDate Filter by whether the entry date is larger than the provided date "2023-12-15T18:48:28.775Z"
maxDate Filter by whether the entry date is smaller than the provided date "2023-12-15T18:48:28.775Z"