AuditLogs

Returns a list of audit log entries.

<br>You must have this scope: 'logs.read'.<br>For fine-grained clients, you must have this permission: 'core.audit_logs.read'.

get/logs/v0-nsfw/audit-logs

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/logs/v0-nsfw/audit-logs
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: logs.read, admin

Query parameters

fromstring date-time

The start of the time interval<br />A date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring date-time

The end of the time interval, must be larger than 'from'<br />A date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

aggregateTypesstring[]

The types of entities being tracked as a group. Example: If a unit maintenance is created, the AggregateType would be Unit.

aggregateIdsstring[]

A unique identifiers for the groups of related changes. Example: If a unit maintenance is created, the AggregateId would be the unique ID of that unit.

entityTypesstring[]

The types of the specific objects that were changed. Example: If a unit maintenance is created, the EntityType would be Maintenance.

entityIdsstring[]

A unique identifiers for the specific objects that were changed. Example: If a unit maintenance is created, the EntityId would be the unique ID of that maintenance.

propertyIdsstring[]

Filter result by requested properties

clientIdsstring[]

Filter result by requested clients

subjectIdsstring[]

Filter result by requested subjects

actionsstring[]

Filter result by requested actions

cursorstring

Cursor to get next data page. Results in 204 if there are no items on that page.

pageSizeinteger

Page size. Default value is 50. Maximal value is 500

Response

Success.

nextCursorstring uuid nullable

Cursor to the next page

pageSizeinteger required

Size of the current page

Example response

{
  "logs": [
    {
      "id": "4166de07-a4e7-4231-90b8-9d0bd43967d3",
      "timestamp": "2026-11-02T19:09:10.0381285Z",
      "clientId": "client",
      "subjectId": "subjectId",
      "actionType": "Updated",
      "propertyId": "MUC",
      "aggregateType": "Unit",
      "aggregateId": "MUC-UDF",
      "entityType": "Condition",
      "entityId": "MUC-UDF",
      "previousData": {
        "condition": "Clean"
      },
      "currentData": {
        "condition": "Dirty"
      }
    },
    {
      "id": "4166de07-a4e7-4231-90b8-9d0bd43967d4",
      "timestamp": "2026-11-02T19:09:10.0381324Z",
      "clientId": "client",
      "subjectId": "subjectId",
      "actionType": "Created",
      "propertyId": "MUC",
      "aggregateType": "Unit",
      "aggregateId": "MUC-UDF",
      "entityType": "Maintenance",
      "entityId": "MUC-UDF-SGHZD",
      "currentData": {
        "from": "2026-11-02T00:00:00Z",
        "to": "2026-11-04T00:00:00Z",
        "type": "OutOfService",
        "description": "The remote control for the TV needs to be replaced."
      }
    }
  ],
  "nextCursor": "4166de07-a4e7-4231-90b8-9d0bd43967d4",
  "pageSize": 2
}

Changes

No recorded changes to this operation across all 5 revisions of this API.