Search AuditTrailEntries

GET

api

sys

audittrailentries

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/audittrailentries \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/audittrailentries"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/audittrailentries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

Value	Name
1	Create
2	Update
3	Delete

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 business linked to this record.

string

Filter by short name of the audited entity type (e.g. Coworker, Booking, Charge).

string

Filter by human-readable description of the audit trail entry.

string

Filter by name of the property that was changed.

integer

Filter by type of audit action: 1 = Create, 2 = Update, 3 = Delete.

string

Filter by previous value of the property before the change.

string

Filter by new value of the property after the change.

string

Filter by user or system account that performed the action.

integer

Filter by integer ID of the audited record.

Range Filters

integer

Filter by integer ID of the audited record greater than or equal to this value.

integer

Filter by integer ID of the audited record 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

curl -X GET \
  "https://spaces.nexudus.com/api/sys/audittrailentries?page=1&size=15&orderBy=EntityShortName&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/audittrailentries?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'EntityShortName',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/audittrailentries',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'EntityShortName',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by EntityShortName

curl -X GET \
  "https://spaces.nexudus.com/api/sys/audittrailentries?AuditTrailEntry_EntityShortName=example-value&orderBy=EntityShortName&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/audittrailentries?' + new URLSearchParams({
    AuditTrailEntry_EntityShortName: 'example-value',
    orderBy: 'EntityShortName',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/audittrailentries',
    params={
        'AuditTrailEntry_EntityShortName': 'example-value',
        'orderBy': 'EntityShortName',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/audittrailentries?from_AuditTrailEntry_UpdatedOn=2025-01-01T00:00&to_AuditTrailEntry_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/audittrailentries?' + new URLSearchParams({
    from_AuditTrailEntry_UpdatedOn: '2025-01-01T00:00',
    to_AuditTrailEntry_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/audittrailentries',
    params={
        'from_AuditTrailEntry_UpdatedOn': '2025-01-01T00:00',
        'to_AuditTrailEntry_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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

{
  "Records": [
    {
      "BusinessId": 0,
      "EntityShortName": "",
      "Description": "",
      "PropertyName": "",
      "AuditType": 0,
      "NewValue": null,
      "ActionBy": null,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "EntityShortName",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one AuditTrailEntryRetrieve a single AuditTrailEntry record by its Id.

Search AuditTrailEntries

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/audittrailentries \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/audittrailentries"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/audittrailentries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by EntityShortName

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by EntityShortName

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by EntityShortName

Range filters

Response

200