Audit API

OpenIndex writes audit records for significant system events — work item mutations, agent runs, domain changes, calendar syncs, and more. Use the audit API to query, filter, and export these records. All audit endpoints require a Bearer token. See API Authentication.

What the audit log captures

Work item events

Work item creation, updates, and deletion
Status transitions (including agent claim and complete)
Stage gate progressions
Comment and attachment changes
Custom field value changes

Agent runs

Agent claim and completion events
Agent dispatch and execution outcomes
Stage gate advancement by agents

Domain and membership changes

Domain creation, updates, and deletion
Member additions, role changes, and removals

Calendar sync

Calendar source creation and deletion
Sync success and failure events for each source

Admin actions

User suspension and unsuspension
AI provider configuration changes
Email infrastructure provisioning

List audit log entries

GET /audit
Authorization: Bearer <your-pat>

Returns audit log entries in reverse chronological order.

string

Filter entries for a specific work item (e.g. OPS-42).

string

Filter entries for a specific domain.

string

Filter by event type (e.g. work_item.status_changed, agent.claimed).

string

Filter entries by the user who performed the action.

string

Return entries before this ISO 8601 timestamp.

string

Return entries after this ISO 8601 timestamp.

curl --request GET \
  --url 'https://your-deployment.convex.site/audit?workItemKey=OPS-42' \
  --header 'Authorization: Bearer oi_pat_...'

{
  "entries": [
    {
      "id": "audit_abc123",
      "eventType": "work_item.status_changed",
      "workItemKey": "OPS-42",
      "userId": "user_xyz789",
      "before": { "status": "in_progress" },
      "after": { "status": "completed" },
      "timestamp": "2026-03-31T10:05:00Z"
    }
  ],
  "cursor": "cursor_next_page"
}

Export audit log

GET /audit/export
Authorization: Bearer <your-pat>

Exports audit log entries as a downloadable file. Supports the same filter parameters as GET /audit.

string

default:"json"

Export format: json or csv.

curl --request GET \
  --url 'https://your-deployment.convex.site/audit/export?format=json' \
  --header 'Authorization: Bearer oi_pat_...' \
  --output audit-export.json

curl --request GET \
  --url 'https://your-deployment.convex.site/audit/export?format=csv' \
  --header 'Authorization: Bearer oi_pat_...' \
  --output audit-export.csv

Via CLI:

# List audit entries for a work item
oi work-item audit list OPS-42

# Export audit log to CSV
oi work-item audit export OPS-42 --format csv --output ./export.csv

Operational statistics

GET /stats
Authorization: Bearer <your-pat>

Returns current operational statistics for the instance, including:

Total work item counts by kind and status
Active workflow counts
Agent queue depth
Recent sync activity

object

Show properties

number

Total work items across all domains.

object

Counts broken down by project, task, and sub_task.

object

Counts broken down by status value.

object

Show properties

number

Number of work items currently waiting for agent pickup.

number

Number of work items currently claimed by agents.

Overview

Work Items

Integrations

What the audit log captures

List audit log entries

Export audit log

Operational statistics

​What the audit log captures

​List audit log entries

​Export audit log

​Operational statistics

What the audit log captures

List audit log entries

Export audit log

Operational statistics