# List events.

Returns a paginated list of events.

Endpoint: POST /events
Version: v3
Security: oauth2

## Request fields (application/json):

  - `sortSpecifications` (array)

  - `sortSpecifications.field` (string, required)

  - `sortSpecifications.sort` (string,null)

  - `sortSpecifications.isSortDescending` (boolean)

  - `filterSpecifications` (array)

  - `filterSpecifications.operator` (string, required)

  - `filterSpecifications.value` (any)

  - `filterSpecifications.filterConditionOperator` (any)

  - `page` (integer,null)

  - `pageSize` (integer,null)

## Response 200 fields (text/plain):

  - `before` (integer)

  - `after` (integer)

  - `total` (integer)

  - `items` (array,null)

  - `items.id` (string)
    Gets the event id which acts as the primary key in the database.

  - `items.name` (string,null, required)
    Gets or sets the event name.

  - `items.description` (string,null)
    Gets or sets the event description.

  - `items.startTime` (string, required)
    Gets or sets the event start time.

  - `items.endTime` (string,null)
    Gets or sets the event end time.

  - `items.eventTypeId` (integer, required)
    Gets the event type id which is defined by Willow, e.g. CalendarEvent, WeatherForecast, UtilityBill, ….

  - `items.eventSourceId` (string,null)
    Gets the name of the source system, which is for informational purposes.

  - `items.externalId` (string,null)
    Gets an Id linking it to the source system, facilitating updates and deletes.

  - `items.payload` (string,null, required)
    Gets or sets a JSON string containing type-specific values.

  - `items.payloadVersion` (string,null, required)
    Gets or sets a version for the payload to assist in the deserialization of the payload.

  - `items.scalarValue` (number,null)
    Gets or sets a double value that may be stored to complement the Payload value.

  - `items.twinId` (string,null, required)
    Gets the id of the twin that is a reference to to an existing space, or equipment twin.

  - `items.locations` (string,null)
    Gets or sets a JSON string with the expanded location ancestors for the twinId.

  - `items.createdDate` (string, required)
    Gets or sets the date the event was created in the system.

  - `items.lastModifiedDate` (string, required)
    Gets or sets the date the event was last modified in the system.