List Audit Logs

Retrieve audit logs for your organization with cursor-based pagination. Requires an Enterprise subscription and organization admin or owner role.

GET/api/v1/audit-logs

Authorization

apiKey
X-API-Key<token>

Your Sim API key (personal or workspace). Generate one from the Sim dashboard under Settings > API Keys.

In: header

Query Parameters

action?string

Filter by action type (e.g., workflow.created, workflow.deployed, member.invited).

resourceType?string

Filter by resource type (e.g., workflow, workspace, member).

resourceId?string

Filter by a specific resource ID.

workspaceId?string

Filter to audit logs from a specific workspace.

actorId?string

Filter by the user who performed the action. Must be a member of your organization.

startDate?string

Only return logs after this ISO 8601 timestamp (inclusive).

Formatdate-time
endDate?string

Only return logs before this ISO 8601 timestamp (inclusive).

Formatdate-time
includeDeparted?boolean

When true, includes audit logs from users who have left the organization.

limit?integer

Maximum number of audit log entries to return per page. Must be between 1 and 100.

Range1 <= value <= 100
cursor?string

Pagination cursor returned from a previous request's nextCursor field.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET \  "https://www.sim.ai/api/v1/audit-logs?workspaceId=YOUR_WORKSPACE_ID" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "audit_2c3d4e5f6g",
      "workspaceId": "ws_xyz789",
      "actorId": "user_abc123",
      "actorName": "Jane Smith",
      "actorEmail": "jane@example.com",
      "action": "workflow.deployed",
      "resourceType": "workflow",
      "resourceId": "wf_1a2b3c4d5e",
      "resourceName": "Customer Support Agent",
      "description": "Deployed workflow Customer Support Agent",
      "metadata": null,
      "createdAt": "2025-06-20T14:15:22Z"
    }
  ],
  "nextCursor": "string",
  "limits": {
    "workflowExecutionRateLimit": {
      "sync": {
        "requestsPerMinute": 60,
        "maxBurst": 10,
        "remaining": 59,
        "resetAt": "2025-06-20T14:16:00Z"
      },
      "async": {
        "requestsPerMinute": 60,
        "maxBurst": 10,
        "remaining": 59,
        "resetAt": "2025-06-20T14:16:00Z"
      }
    },
    "usage": {
      "currentPeriodCost": 1.25,
      "limit": 50,
      "plan": "pro",
      "isExceeded": false
    }
  }
}
{
  "error": "string",
  "details": [
    {}
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}