Sessions: Supported Filters

Field support for filters depends on the type of sessions you are querying: session instances of type EVENT, session instances of all types, or recurring session definitions. They also depend on whether includeExternal is true.

Wix Calendar session instances of type EVENT (Default)

The following table shows field support for filters for session instances of type EVENT when includeExternal is false:

Logical Operators
$and, $or, $not
FieldSupported Filters
scheduleIdeq, ne, in
scheduleOwnerIdeq, ne, in
scheduleOwnerNameeq, ne, in
affectedSchedulesexists
affectedSchedules.scheduleIdhasSome, hasAll
affectedSchedules.transparencyhasSome, hasAll
affectedSchedules.scheduleOwnerIdhasSome, hasAll
affectedSchedules.scheduleOwnerNamehasSome, hasAll
titleeq, ne, in, startsWith
tagshasSome, hasAll
locationexists
location.locationTypeeq, ne, in
location.customAddressexists
location.customAddress.formattedAddresseq, ne, in, startsWith
location.businessLocationexists
location.businessLocation.ideq, ne, in
location.businessLocation.nameeq, ne, in, startsWith
location.businessLocation.address.formattedAddresseq, ne, in, startsWith
capacityeq, ne, gt, lt, gte, lte, exists
remainingCapacityeq, ne, gt, lt, gte, lte
numberOfParticipantseq, ne, gt, lt, gte, lte
participants.idhasSome, hasAll
participants.contactIdhasSome, hasAll
participants.approvalStatushasSome, hasAll
inheritedFieldshasSome, hasAll
recurringSessionIdeq, ne, in, exists
calendarConferenceexists
calendarConference.ideq, ne, in
calendarConference.externalIdeq, ne, in
calendarConference.providerIdeq, ne, in
instanceOfRecurrenceeq, ne, in, exists

Session instances of all types

The following table shows field support for filters for session instances of all types. When includeExternal is true this table always applies, even if you only query session instances of type EVENT:

Logical Operators
$and
FieldSupported Filters
scheduleIdeq, in
affectedSchedules.scheduleIdhasSome, hasAll
tagshasSome
location.locationTypeeq, in
location.businessLocation.ideq, in
participants.contactIdhasSome
recurringSessionIdeq, in
calendarConferenceexists

Recurring sessions

The following table shows field support for filters for recurring session definitions:

FieldSupported Filters
scheduleIdeq, in

To learn about working with Query endpoints in general, see API Query Language.

Was this helpful?
Yes
No