Sign in

v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB
Server Audit Logs

Getting Audit Log Entries

This resource allows access to those log entries, with some paging and filtering options. These are provided by querystring parameters: action allows filtering by the action types listed above, start and end allow filtering by log timestamp (see below), and limit and offset control paging. If no paging parameters are given, the server will attempt to return every audit log entry that it has.

The start and end parameters work based on exact timestamps, given in ISO 8601 format. It is possible to provide just a datestring (eg 2000-01-01), in which case midnight will be inferred. But this value alone leaves the timezone unspecified. When no timezone is given, the server's local time will be used: the standard Docker deployment will always set server local time to UTC, but installations may have been customized, and there is no guarantee the UTC default hasn't been overridden.

For this reason, we recommend always setting a timezone when querying based on start and end: either by appending a z to indicate UTC (eg 2000-01-01z) or by explicitly specifying a timezone per ISO 8601 (eg 2000-01-01+08). The same applies for full timestamps (eg 2000-01-01T12:12:12z, 2000-01-01T12:12:12+08).

start may be given without end, and vice versa, in which case the timestamp filter will only be bounded on the specified side. start is inclusive, and end is exclusive (>= and <, respectively).

This endpoint supports retrieving extended metadata; provide a header X-Extended-Metadata: true to additionally expand the actorId into full actor details, and acteeId into full actee details. The actor will always be an Actor, but the actee may be an Actor, a Project, a Form, or some other type of object depending on the type of action.

get/v1/audits

Query parameters

actionstring

The name of the action to filter by.

startstring

The timestamp before which log entries are to be filtered out.

endstring

The timestamp from which log entries are to be filtered out.

limitnumber

The maximum number of entries to return.

offsetnumber

The zero-indexed number of entries to skip from the result.

Response

OK

actorIdnumber

The ID of the actor, if any, that initiated the action.

actionstring required

The action that was taken.

acteeIdstring

The ID of the permissioning object against which the action was taken.

detailsobject

Additional details about the action that vary according to the type of action.

loggedAtstring required

ISO date format

Example response

[
  {
    "actorId": 42,
    "action": "form.create",
    "acteeId": "85cb9aff-005e-4edd-9739-dc9c1a829c44",
    "loggedAt": "2018-04-18T23:19:14.802Z"
  }
]