Skip to content

Audit Events API

A read-only log of significant actions taken on your account. Each event records who did what, to which resource, and when — useful for compliance, debugging, and tracking changes over time.

List Audit Events

GET /api/v1/audit-events?limit=50

Supports the following query parameters:

Parameter Required Description
limit No Number of events to return, 1–100 (default 50)
cursor No Pagination cursor from a previous response
action No Filter to events with this exact action (e.g. import.created)
resource_type No Filter to events for this resource type (e.g. import)
resource_id No Filter to events for this specific resource ID

Response:

{
  "data": [
    {
      "id": "evt_01XYZ",
      "actor": "api_key:inv_01ABC",
      "action": "import.created",
      "resource_type": "import",
      "resource_id": "imp_01XYZ",
      "workspace_id": null,
      "ip_address": "203.0.113.10",
      "user_agent": "curl/8.4.0",
      "request_id": "req_01ABC",
      "summary": "csv, 1 rows",
      "created_at": "2026-07-20T10:00:00Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  }
}
Try it

Get Audit Event

GET /api/v1/audit-events/{audit_event_id}

Response:

{
  "data": {
    "id": "evt_01XYZ",
    "actor": "api_key:inv_01ABC",
    "action": "import.created",
    "resource_type": "import",
    "resource_id": "imp_01XYZ",
    "workspace_id": null,
    "ip_address": "203.0.113.10",
    "user_agent": "curl/8.4.0",
    "request_id": "req_01ABC",
    "summary": "csv, 1 rows",
    "created_at": "2026-07-20T10:00:00Z"
  }
}
Try it

Event Fields

Field Description
id Unique identifier for the audit event
actor Who performed the action (e.g. the API key or user)
action The action performed (e.g. import.created, import.confirmed)
resource_type Type of resource the action targeted
resource_id Identifier of the affected resource
workspace_id Workspace the action occurred in, if applicable
ip_address Source IP address of the request
user_agent User agent of the request
request_id Identifier of the originating API request
summary Short human-readable description of the event
created_at When the event was recorded