API reference

Audit

The log of employee and integration actions.

List audit events

GET/v1/audit-events

Scopes
audit:read

Filters combine with AND. A cursor is bound to the filter it was issued for; another filter with that cursor is 400. Invalid filter value is 400 schema_validation_failed.

Parameters

FieldTypeRequired
cursorquerystringno
limitqueryintegerno
actor_idqueryOnly events of this actor.string (uuid)no
actor_typequeryOnly events of this actor type.enum: api_key, console_user, applicant_session, appeal_session, service, system, platform, platform_supportno
actionqueryOnly events with this action (exact match).stringno
resource_typequeryOnly events about this resource type.stringno
resource_idqueryOnly events about this resource.string (uuid)no
occurred_fromqueryOccurred at or after this time.string (date-time)no
occurred_toqueryOccurred before this time.string (date-time)no

Responses

  • 200AuditEventList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503