Skip to navigation

Get Events

Retrieve a paginated list of events for your organization.

Query parameters

event_typeslist of integersOptional
List of event type IDs to filter by.
locationslist of integersOptional
List of location IDs to filter by.
itemintegerOptional
Item ID to filter events by.
limitintegerOptionalDefaults to 10
Number of records to return per page.
pageintegerOptionalDefaults to 1
Page number to fetch.
include_child_locationsbooleanOptionalDefaults to false
Include events from child locations of the specified locations.
from_dtmdatetimeOptional

Filter events starting on or after this ISO-8601 date-time.

to_dtmdatetimeOptional

Filter events ending on or before this ISO-8601 date-time.

searchstringOptional
Keyword search across event titles.

Response

200 response
eventslist of objectsOptional
metaobjectOptional