AuditTrailEntries
Search AuditTrailEntries
Search and list AuditTrailEntry records with filtering, sorting, and pagination.
GET
Represents a read-only log of entity creations and modifications by users or the system. Useful for troubleshooting issues or finding out when an entity was created and what modifications were made to it.
Creation entries (
AuditType = 1) do not record the values for the individual fields. To infer the initial values, look at the first update entry for that entity and read the OldValue for each property.
Use AuditTrailEntry_EntityId to search by the integer ID of the audited record.
Not all entities are fully audited. These are the ones currently supported by the AuditTrailEntry_EntityShortName filter:
Charge, ContractSchedule, CoworkerBookingCredit, CoworkerContract, CoworkerExtraService, CoworkerInvoice, CoworkerLedgerEntry, CoworkerPaymentMethod, CoworkerProduct, FinancialAccount, CoworkerTask, CrmOpportunity, Booking, Checkin, Coworker, CoworkerIdentityCheck, Resource, Team, Visitor, Business, BusinessSetting, FloorPlanDesk, User.
The AuditType field uses the eAuditType enum: 1 = Create, 2 = Update, 3 = Delete.
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
eAuditType — AuditType values
eAuditType — AuditType values
| Value | Name |
|---|---|
| 1 | Create |
| 2 | Update |
| 3 | Delete |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by Business Id.
Filter by short name of the audited entity type (e.g. Coworker, Booking, Charge).
Filter by human-readable description of the audit trail entry.
Filter by name of the property that was changed.
Filter by type of audit action: 1 = Create, 2 = Update, 3 = Delete.
Filter by previous value of the property before the change.
Filter by new value of the property after the change.
Filter by user or system account that performed the action.
Filter by integer ID of the audited record.
Range Filters
Filter by integer ID of the audited record greater than or equal to this value.
Filter by integer ID of the audited record less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by EntityShortName
Range filters
Response
200
The list of AuditTrailEntry records matching the query. See the Get one AuditTrailEntry endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response