Get History

Retrieves a collection of history records with optional paging parameters. Paging parameters include startIndex, pageSize, sortBy, filter, q, and qLimit.

GET /history

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "action": "<string>",
      "appKey": "<string>",
      "correlationId": "<string>",
      "entityId": "<string>",
      "entityType": "<string>",
      "id": "<string>",
      "initiatingAppId": "<string>",
      "ipAddress": "<string>",
      "objectName": "<string>",
      "siteId": 123,
      "tenantId": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "userId": "<string>"
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

StartIndex · integer<int32>

PageSize · integer<int32>

SortBy · string

Filter · string

Q · string

QLimit · integer<int32>

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>