List Events

GET /events

You can use this endpoint to retrieve a list of events. Optionally, you can use the filter parameter to filter the list of events.

Use the Pagination and Querying sections to learn more about how to complete this request.

It is default sorted by createdAt DESC. The default and max limit is 100 for events.

Available Fields to Query

Field NameTypeDescription
CREATED_ATdateThe creation timestamp of the event
START_DATEdateThe start date and time of the event
END_DATEdateThe end date and time of the event

Example: Query events starting after a specific date

Copy
{ "operator": "GREATER_OR_EQUAL", "fieldName": "START_DATE", "value": 1704067200000 }

Example: Query events within a date range

Copy
{ "operator": "AND", "conditions": [ { "operator": "GREATER_OR_EQUAL", "fieldName": "START_DATE", "value": 1704067200000 }, { "operator": "LESSER_OR_EQUAL", "fieldName": "END_DATE", "value": 1735689600000 } ] }

Example Response

Copy
{ "total": 25, "list": [ { "id": "bd4a0997-39db-41d9-883a-cdfa83e2101f", "createdAt": "2024-01-15T09:30:00.000Z", "name": "Summer Festival 2024", "startDate": "2024-07-01T14:00:00.000Z", "endDate": "2024-07-03T22:00:00.000Z", "published": true, "ticketTypes": [] }, ... ] }
Previous
List Transactions
Next
Get Event