v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Events

List events (legacy)

get/v3/events

Query parameters

pagenumber required

Page Number

limitnumber required

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: eventTypeId (string): eq, neq, like, nlike, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull differentiator (string): eq, neq, like, nlike, in, nin, isnull, isnotnull datetime (datetime): eq, neq, gt, gte, lt, lte

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=eventTypeId:eq:value

Response

Get all Events by filter

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "datetime": "2021-01-01T00:00:00.000Z",
        "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "value": "123",
        "differentiator": "DIFF",
        "invoiceGroup": "123",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
}