Query Events

Retrieves a list of events, given the provided paging, filtering, and sorting.

Defaults

Query Events runs with these defaults, which you can override:

• Sorted by start in ASC order.
• cursorPaging.limit is 50.
• WORKING_HOURS events are excluded from the results. To retrieve working hour events, specify "type": "WORKING_HOURS" in the query filter.

Filters

For field support for filters and sorting, see Calendar Events V3: Supported Filters and Sorting.

Date filters

Do not specify filters for start and end dates inside query.filter, instead specify fromLocalDate and toLocalDate.

Unsupported filters

You can't filter by the following fields:

• eventId: To query by event ID call either Get Event or List Events.
• contactId: To query by a participant's contact ID call List Events by Contact ID.
• memberId: To query by a participant's member ID call List Events by Member ID.

See also

To learn about working with Query endpoints, see:

• API Query Language
• Sorting and Paging
• Field Projection

Field	Supported Filters	Sort
transparency	$eq	Sort: ✗
appId	$eq, $in	Sort: ✗
scheduleId	$eq, $in	Sort: ✗
externalScheduleId	$eq, $in	Sort: ✗
type	$eq, $in	Sort: ✗
recurringEventId	$eq, $in	Sort: ✗
location.id	$eq, $in	Sort: ✗
location.type	$eq, $in	Sort: ✗
remainingCapacity	$eq, $ne, $gt, $gte, $lt, $lte	Sort: ✗
participants.total	$eq, $ne, $gt, $gte, $lt, $lte	Sort: ✗
totalCapacity	$eq, $ne, $gt, $gte, $lt, $lte, $exists	Sort: ✗
resources.id	$hasSome, $hasAll	Sort: ✗
resources.type	$hasSome, $hasAll	Sort: ✗
resources.transparency	$hasSome, $hasAll	Sort: ✗
location	$exists	Sort: ✗
conferencingDetails	$exists	Sort: ✗