Post

Query Bookings

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deprecation Notice:

This endpoint has been replaced with Bookings V2 Query Extended Bookings and will be removed on December 31, 2024.

Retrieves a list of bookings according to the provided filters and paging. The query runs with the following defaults:

Copy
1

You can override these defaults, and define other filters and paging, as shown in the following table.

Query object support:

FieldSupported FiltersSortable
bookingId$eq
contactId$eq
sessionId$eq, $in, $hasSome
scheduleId$eq, $in, $hasSome
startTime$gte, $lt
endTime$gt, $lte
status$eq, $in, $hasSome
createdDate$gte, $ltSortable
pagingSupported
fieldsetsNot supported.
fieldsNot supported.

Notes:

  • The following objects in the query parameter are not supported for this query:
    • fields
    • fieldsets
  • Only one use at a time of each filter once in the same query is supported. If a filter will be used more than once in one query, only the first occurrence is taken.
  • Calling Query without a filter, will return all bookings viewable according to the caller's permissions.
  • All results are for one specific business, resolved from the request context.
  • A member should only be able to see their own bookings;
  • To get the available actions for a member for each booking, based on the business bookings policy, use the withBookingAllowedActions field.
  • When using the queryBookings() function immediately following a change to your bookings, the data retrieved may not contain your most recent changes. See Wix-data and Eventual Consistency for more information.
  • The businessLocation.businessSchedule object in the bookedEntity.location object is not supported. Permissions This endpoint requires the Read Bookings - Including Participants permission scope.
Endpoint
POST
https://www.wixapis.com/bookings/v1/bookings/query
Was this helpful?
Yes
No