Skip to main content
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 creation, updates, and deletion
  • Status transitions (including agent claim and complete)
  • Stage gate progressions
  • Comment and attachment changes
  • Custom field value changes
  • Agent claim and completion events
  • Agent dispatch and execution outcomes
  • Stage gate advancement by agents
  • Domain creation, updates, and deletion
  • Member additions, role changes, and removals
  • Calendar source creation and deletion
  • Sync success and failure events for each source
  • 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.
​
query.workItemKey
string
Filter entries for a specific work item (e.g. OPS-42).
​
query.domainId
string
Filter entries for a specific domain.
​
query.eventType
string
Filter by event type (e.g. work_item.status_changed, agent.claimed).
​
query.userId
string
Filter entries by the user who performed the action.
​
query.before
string
Return entries before this ISO 8601 timestamp.
​
query.after
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_...'

​
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.
​
query.format
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
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
​
workItems
object
​
agentQueue
object