Query audit log events

curl -G https://api.synthesia.io/v2/auditLogs/events \
     -H "Authorization: <apiKey>" \
     --data-urlencode actions=billing.credits.consumed,dubbing.project.created \
     --data-urlencode actorIds=user-123,user-456 \
     -d endDate=1706745599 \
     -d startDate=1704067200

{
  "events": [
    {
      "id": "string",
      "action": "string",
      "status": "string",
      "actor": {
        "type": "user",
        "id": "string",
        "name": "string",
        "email": "string"
      },
      "target": {
        "type": "workspace",
        "id": "string",
        "name": "string"
      },
      "context": {
        "workspaceId": "string",
        "organizationId": "string",
        "ipAddress": "string"
      },
      "details": {},
      "metadata": {
        "createdAt": "2024-01-15T09:30:00Z",
        "processedAt": "2024-01-15T09:30:00Z"
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "string"
}

Retrieve paginated audit log events for a workspace or an organization. Exactly one of workspaceId or organizationId must be provided.

Supports filtering by date range (Unix timestamps), multiple actions, multiple actor IDs, and target ID. Any combination of filters can be applied together.

Array parameters use comma-separated values:

Multiple actions: ?actions=billing.credits.consumed,dubbing.project.created
Multiple actors: ?actorIds=user-123,user-456

Example queries:

Latest events: GET /v2/auditLogs/events?workspaceId=12345678-1234-1234-1234-123456789abc&limit=50
Filtered by action and date: GET /v2/auditLogs/events?workspaceId=12345678-1234-1234-1234-123456789abc &actions=billing.credits.consumed&startDate=1704067200&endDate=1706745599
Multiple filters: GET /v2/auditLogs/events?workspaceId=12345678-1234-1234-1234-123456789abc &actions=billing.credits.consumed,dubbing.project.created&actorIds=user-123,user-456

This endpoint is rate-limited and usage is tracked against your API quota.

Authentication

Authorizationstring

API Key authentication via header

Query parameters

workspaceIdstringOptionalformat: "uuid"

Workspace UUID to filter events by (mutually exclusive with organizationId)

organizationIdstringOptionalformat: "uuid"

Organization UUID to filter events by (mutually exclusive with workspaceId)

actionsstringOptional

Comma-separated list of actions to filter by (e.g. “billing.credits.consumed,dubbing.project.created”)

actorIdsstringOptional

Comma-separated list of actor IDs to filter by (e.g. “user-123,user-456”)

targetIdstringOptional

Filter events by target ID

startDateintegerOptional>=0

Filter events created on or after this Unix timestamp (seconds since epoch)

endDateintegerOptional>=0

Filter events created before this Unix timestamp (seconds since epoch)

cursorstringOptional

Opaque cursor for pagination

limitintegerOptional1-200Defaults to 50

Number of events per page (max 200)

Response

Paginated list of audit events

eventslist of objects

List of audit log events

hasMoreboolean

Whether there are more events to fetch

nextCursorstring or nullOptional

Opaque cursor for fetching the next page. Pass as cursor parameter.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error