Skip to main content
GET
/
api
/
sys
/
audittrailentries
/
{id}
{
  "BusinessId": 123,
  "EntityShortName": "<string>",
  "Description": "<string>",
  "PropertyName": "<string>",
  "AuditType": 123,
  "OldValue": "<string>",
  "NewValue": "<string>",
  "ActionBy": "<string>",
  "EntityId": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the AuditTrailEntry record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/audittrailentries/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
Business Id.
​
EntityShortName
string
Short name of the audited entity type (e.g. Coworker, Booking, Charge).
​
Description
string
Human-readable description of the audit trail entry.
​
PropertyName
string
Name of the property that was changed.
​
AuditType
integer
Type of audit action: 1 = Create, 2 = Update, 3 = Delete. See eAuditType enum values: 1 = Create, 2 = Update, 3 = Delete.
​
OldValue
string
Previous value of the property before the change.
​
NewValue
string
New value of the property after the change.
​
ActionBy
string
User or system account that performed the action.
​
EntityId
integer
Integer ID of the audited record.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "EntityShortName": "",
  "Description": "",
  "PropertyName": "",
  "AuditType": 0,
  "OldValue": null,
  "NewValue": null,
  "ActionBy": null,
  "EntityId": 0,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "AuditTrailEntry Example",
  "LocalizationDetails": null,
  "CustomFields": null
}