Retrieves a list of events, given the provided paging, filtering, and sorting.
Query Events runs with these defaults, which you can override:
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.Do not specify filters for start and end dates inside query.filter, instead
specify fromLocalDate and toLocalDate.
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.To learn about working with Query endpoints, see:
| Property | Filters | Sort |
|---|---|---|
transparency | $eq | None |
appId | $eq, $in | None |
scheduleId | $eq, $in | None |
externalScheduleId | $eq, $in | None |
type | $eq, $in | None |
recurringEventId | $eq, $in | None |
location._id | $eq, $in | None |
location.type | $eq, $in | None |
remainingCapacity | $eq, $ne, $gt, $gte, $lt, $lte | None |
participants.total | $eq, $ne, $gt, $gte, $lt, $lte | None |
totalCapacity | $eq, $ne, $gt, $gte, $lt, $lte, $exists | None |
resources._id | $hasSome, $hasAll | None |
resources.type | $hasSome, $hasAll | None |
resources.transparency | $hasSome, $hasAll | None |
location | $exists | None |
conferencingDetails | $exists | None |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.