History

Every change, who made it and when.

Paths are relative to https://evenbooks.org/api/v1. How keys, errors, paging and versions work is in the guide; the whole reference is also an OpenAPI 3.1 document.

Administrator key marks endpoints that need a key with the admin role, Write access those a read-only key can’t call, and Idempotent those that accept an idempotency key.

List history events

get/audit

Every change in the company, newest first: who made it (a person, an API key with its name, or the system), the action, the record and any reason. Filter by record with entityType and entityId, and by day with from and to (inclusive, in the company’s time zone). No total.

Parameters

  • limitintegerquery

    1–200 · default 50

  • cursorstringquery

    pattern ^\d{1,15}$

  • entityTypestringquery

    up to 64 characters

  • entityIdstringquery

    up to 200 characters

  • fromstring · PlainDateStringquery
  • tostring · PlainDateStringquery

Response 200

A page of AuditEventDto ({ items, nextCursor, total }, see paging).

Errors 400 · 401 · 403 · 404 · 409 · 429

Schemas

The types these endpoints take or return, by name. Type names above link here.

AuditEventDto

  • idnumber
  • actorTypestring

    One of: user system job api_key

  • actorIdstring
  • actorNamestring or nulloptional
  • actionstring
  • entityTypestring
  • entityIdstring or null
  • reasonstring or null
  • detailsmap of any
  • requestIdstring or null
  • jobIdstring or null
  • createdAtstring

PlainDateString

string

pattern ^\d{4}-\d{2}-\d{2}$