Skip to main content
GET
Search AuditTrailEntries
AuditTrailEntry is a read-only location activity log for audited record creations, updates, and deletions, including the field values recorded for updates.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the AuditTrailEntry-List role.

Enums

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by iD of the location where the audited record belongs..
string
Filter by internal type name of the audited record, such as Coworker, Booking, or Charge..
string
Filter by system-generated, human-readable summary of the audited action and the account that performed it..
string
Filter by display name of the entity field changed by an update, or the audited entity name for a creation or deletion..
integer
Filter by audited action: Create (1), Update (2), or Delete (3)..
string
Filter by display-formatted value of the changed field before an update; blank for creation records..
string
Filter by display-formatted value of the changed field after an update; blank for creation records..
string
Filter by username recorded for the action, with the IP address in parentheses when available..
integer
Filter by integer ID of the audited record; combine it with EntityShortName to identify the record type..

Range Filters

integer
Filter by integer ID of the audited record; combine it with EntityShortName to identify the record type. greater than or equal to this value.
integer
Filter by integer ID of the audited record; combine it with EntityShortName to identify the record type. less than or equal to this value.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by EntityShortName

Range filters

Response

200

AuditTrailEntry[]
The list of AuditTrailEntry records matching the query. See the Get one AuditTrailEntry endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each AuditTrailEntry. The following fields are not populated in the Records[] response: OldValue, EntityId.To get all fields, fetch the full record using the Get one AuditTrailEntry endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response