Pre-release — content may change.

Change logs

List audit-trail versions

GET
/versions

A cursor-paginated list of audit-trail version records, newest first. Restricted to administrators and change-log viewers. Only versions with recorded changes for an allowlisted item type are returned.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

page?

Cursor pagination parameters. Used by endpoints that paginate unbounded collections via before / after opaque cursors.

filter?

Filter predicates on version attributes. Keys take the form filter[<attribute>_<predicate>]=<value>, repeatable per query.

Notable filters: filter[item_type_eq], filter[event_eq], filter[entity_type_eq] and filter[entity_uuid_eq] (scope to a single entity), and date-range predicates on created_at.

Common predicates by attribute type:

  • String / text: eq, not_eq, cont, not_cont, matches, start, end, present, blank, null, not_null, in, not_in
  • Datetime: eq, not_eq, gt, gteq, lt, lteq, present, blank, null, not_null, in, not_in
fields[versions]?array<>

Sparse-fieldset selection.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/versions"
{  "data": [    {      "type": "versions",      "id": "string",      "attributes": {        "item_type": "string",        "item_id": "string",        "event": "string",        "entity_type": "string",        "entity_uuid": "ccd0bbaa-1979-4620-9054-a91c61d70e41",        "entity_name": "string",        "whodunnit": "string",        "whodunnit_name": "string",        "whodunnit_is_admin": true,        "user_agent": "string",        "request_id": "string",        "created_at": "2019-08-24T14:15:22Z",        "formatted_changes": [          {            "path": "string",            "old_value_raw": null,            "new_value_raw": null,            "old_value_friendly": "string",            "new_value_friendly": "string",            "label": "string",            "fallback_label": "string",            "display_order": "string",            "meta": {}          }        ],        "formatted_changes_title": "string",        "formatted_changes_relationship_meta": {          "previous_from_uuid": "string",          "previous_from_type": "string",          "previous_from_name": "string",          "previous_to_uuid": "string",          "previous_to_type": "string",          "previous_to_name": "string",          "current_from_uuid": "string",          "current_from_type": "string",          "current_from_name": "string",          "current_to_uuid": "string",          "current_to_type": "string",          "current_to_name": "string"        }      },      "links": {        "self": "/versions/7247ad7d-9275-454b-9e3a-0570e403739e"      },      "meta": {}    }  ],  "meta": {    "page": {      "before": "string",      "after": "string",      "size": 0    }  },  "links": {    "prev": "/versions?page%5Bbefore%5D=WyIyMDI2LTA2LTAxIl0&page%5Bsize%5D=25",    "next": "/versions?page%5Bafter%5D=WyIyMDI2LTA1LTAxIl0&page%5Bsize%5D=25"  }}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}