Bookings Reader V2: Supported Filters

The following table shows field support for filters for the extended booking object in Query Extended Bookings and Count Extended Bookings:

Field	Supported Filters
id	eq, ne, in
bookedEntity.item.slot.sessionId	eq, ne, in
bookedEntity.item.slot.eventId	eq, ne, in
bookedEntity.item.slot.serviceId	eq, ne, in
bookedEntity.item.slot.scheduleId	eq, ne, in
bookedEntity.item.slot.resource.id	eq, ne, in
bookedEntity.item.slot.location.id	eq, ne, in
bookedEntity.item.slot.location.locationType	eq, ne, in
bookedEntity.item.schedule.scheduleId	eq, ne, in
bookedEntity.item.schedule.serviceId	eq, ne, in
bookedEntity.item.schedule.location.id	eq, ne, in
bookedEntity.item.schedule.location.locationType	eq, ne, in
bookedEntity.tags	hasSome, hasAll
contactDetails.contactId	eq, ne, in
contactDetails.email	eq, ne, in
status	eq, ne, in
paymentStatus	eq, ne, in
selectedPaymentOption	eq, ne, in
createdDate	eq, ne, gt, gte, lt, lte, in, nin
externalUserId	eq, ne, in
createdBy.contactId	eq, ne, in
createdBy.id.appId	eq, ne, in
createdBy.id.wixUserId	eq, ne, in
createdBy.id.memberId	eq, ne, in
createdBy.id.anonymousVisitorId	eq, ne, in
startDate	eq, ne, gt, gte, lt, lte, in, nin
endDate	eq, ne, gt, gte, lt, lte, in, nin
updatedDate	eq, ne, gt, gte, lt, lte, in, nin
doubleBooked	eq, ne
participantsInfo.type.totalParticipants.value	eq, ne, gt, gte, lt, lte, in, nin
participantsInfo.type.participantsChoices.serviceChoices.choices.optionId	hasSome, hasAll
participantsInfo.type.participantsChoices.serviceChoices.choices.choice.custom.value	hasSome, hasAll

When using filters for dates, you must use UTC time.

Filter Performance

For optimal query performance, use at least one of the following fields when filtering data:

• id
• startDate
• endDate
• contactDetails.contactId
• contactDetails.email
• bookedEntity.item.slot.sessionId
• bookedEntity.item.schedule.scheduleId
• bookedEntity.item.slot.eventId

We strongly recommend including startDate as filter in all Query Extended Bookings requests, especially when not using any of the other filters listed above.

See also

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.