List Audit Logs

List an organization audit trail with filters and opaque cursor pagination. Requires an Enterprise subscription and organization admin or owner access. A workspace API key cannot call this operation and is rejected with 403; use a personal API key.

GET/api/v2/audit-logs

Authorization

apiKey
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one from the Sim dashboard under Settings > API Keys. A workspace API key is not accepted everywhere: operations that act on behalf of a specific human — administrative reads, secret access, and irreversible or governance-affecting writes — always reject it, whatever role the key carries. Each such operation says so in its own description, and the rejection surfaces as 403 unless the operation conceals unauthorized resources, in which case it is reported as 404. Use a personal API key for those.

In: header

Query Parameters

action?string

Filter by exact action name.

resourceType?string

Filter by exact resource type.

resourceId?string

Filter by exact resource identifier.

workspaceId?string

Filter to actions in one workspace.

startDate?string

Inclusive ISO 8601 start timestamp.

endDate?string

Inclusive ISO 8601 end timestamp.

includeDeparted?string

Include actions by users who have left the organization.

Default"false"
Value in"true" | "false"
limit?number

Maximum entries per page, from 1 to 100.

Default50
Range1 <= value <= 100
cursor?string

Opaque cursor returned by the previous page.

organizationId*string

Organization whose audit trail should be queried.

Length1 <= length
actorEmail?string

Filter by actor email address.

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/audit-logs?organizationId=string"
{
  "data": [
    {
      "id": "audit_2c3d4e5f6g",
      "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
      "actorName": "Jane Smith",
      "actorEmail": "jane@example.com",
      "action": "file.uploaded",
      "resourceType": "file",
      "resourceId": "wf_V1StGXR8z5jdHi6BmyT91",
      "resourceName": "data.csv",
      "description": "Uploaded file \"data.csv\" via API",
      "metadata": {
        "fileSize": 1024,
        "fileType": "text/csv"
      },
      "createdAt": "2026-01-15T10:30:00Z"
    }
  ],
  "nextCursor": null
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
GETGet Audit Log