Skip to main content
GET
/
api
/
v1
/
audit-logs
List Audit Logs
curl --request GET \
  --url https://api.example.com/api/v1/audit-logs/
{
  "items": [
    {
      "id": 123,
      "account_id": "<string>",
      "operation": "<string>",
      "table_name": "<string>",
      "record_id": "<string>",
      "column_name": "<string>",
      "user_id": "<string>",
      "user_email": "<string>",
      "user_name": "<string>",
      "occurred_at": "2023-11-07T05:31:56Z",
      "old_value": "<string>",
      "new_value": "<string>",
      "es_username": "<string>",
      "es_reason": "<string>",
      "es_timestamp": "2023-11-07T05:31:56Z",
      "ip_address": "<string>",
      "user_agent": "<string>",
      "request_id": "<string>",
      "checksum": "<string>",
      "previous_hash": "<string>",
      "extra_metadata": {}
    }
  ],
  "total": 123,
  "skip": 123,
  "limit": 123
}

Headers

authorization
string | null

Query Parameters

account_id
string | null

Filter by account ID

table_name
string | null

Filter by table name

record_id
string | null

Filter by record ID

user_id
string | null

Filter by user ID

operation
string | null

Filter by operation (CREATE, UPDATE, DELETE)

from_date
string<date-time> | null

Filter from this timestamp (ISO 8601)

to_date
string<date-time> | null

Filter to this timestamp (ISO 8601)

skip
integer
default:0

Number of entries to skip

Required range: x >= 0
limit
integer
default:50

Maximum number of entries to return

Required range: 1 <= x <= 500
sort_by
string
default:occurred_at

Field to sort by

sort_order
string
default:desc

Sort order (asc or desc)

Response

Successful Response

Response for listing audit logs.

items
AuditLogResponse · object[]
required

List of audit log entries

total
integer
required

Total number of entries matching filters

skip
integer
required

Number of entries skipped

limit
integer
required

Number of entries returned