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:

FieldSupported Filters
ideq, ne, in
bookedEntity.item.slot.sessionIdeq, ne, in
bookedEntity.item.slot.eventIdeq, ne, in
bookedEntity.item.slot.serviceIdeq, ne, in
bookedEntity.item.slot.scheduleIdeq, ne, in
bookedEntity.item.slot.resource.ideq, ne, in
bookedEntity.item.slot.location.ideq, ne, in
bookedEntity.item.slot.location.locationTypeeq, ne, in
bookedEntity.item.schedule.scheduleIdeq, ne, in
bookedEntity.item.schedule.serviceIdeq, ne, in
bookedEntity.item.schedule.location.ideq, ne, in
bookedEntity.item.schedule.location.locationTypeeq, ne, in
bookedEntity.tagshasSome, hasAll
contactDetails.contactIdeq, ne, in
contactDetails.emaileq, ne, in
statuseq, ne, in
paymentStatuseq, ne, in
selectedPaymentOptioneq, ne, in
createdDateeq, ne, gt, gte, lt, lte, in, nin
externalUserIdeq, ne, in
createdBy.contactIdeq, ne, in
createdBy.id.appIdeq, ne, in
createdBy.id.wixUserIdeq, ne, in
createdBy.id.memberIdeq, ne, in
createdBy.id.anonymousVisitorIdeq, ne, in
startDateeq, ne, gt, gte, lt, lte, in, nin
endDateeq, ne, gt, gte, lt, lte, in, nin
updatedDateeq, ne, gt, gte, lt, lte, in, nin
doubleBookedeq, ne
participantsInfo.type.totalParticipants.valueeq, ne, gt, gte, lt, lte, in, nin
participantsInfo.type.participantsChoices.serviceChoices.choices.optionIdhasSome, hasAll
participantsInfo.type.participantsChoices.serviceChoices.choices.choice.custom.valuehasSome, 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.

Did this help?