POST

Query Extended Bookings


Retrieves up to 100 bookings, given the specified paging, filtering, and sorting.

Query Extended Bookings runs with these defaults, which you can override:

  • id sorted in ASC order
  • cursorPaging.limit is 50

To retrieve course bookings, filter by scheduleId of the relevant service.

You can retrieve information about which actions the customer can perform for the bookings. To do so, pass withBookingAllowedActions as true.

For field support see supported filters for more information.

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

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

Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Including Participants
Read bookings calendar - including participants
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/_api/bookings-reader/v2/extended-bookings/query

Body Params
queryQueryRequired

Information about filters, paging, and sorting.


withBookingAllowedActionsboolean

Whether to return information about the actions the customer can perform for the bookings.


withBookingAttendanceInfoboolean

Whether to return information about the attendance for the bookings.


withBookingConferencingDetailsboolean

Whether to return information about the online conferencing details for the bookings.


withBookingPolicySettingsboolean

Whether to retrieve information about booking policy settings.

You must have the BOOKINGS.BOOKING_POLICY_SNAPSHOT_READ permission scope when passing true.

Default: false.


withBookingFeeDetailsboolean

Whether to retrieve information about the booking fee statuses. Information about booking fees with a status of PREVIEW isn't returned.

You must have the BOOKINGS.BOOKING_FEES_READ permission scope when passing true. To retrieve complete booking fee objects or to get information about PREVIEW fees, use List Booking Fees By Booking Ids instead.

Default: false

Response Object
extendedBookingsArray <ExtendedBooking>

Retrieved bookings.

May include information about the attendance or actions the customer can perform, depending on your request.


pagingMetadataPagingMetadata

Paging metadata.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/bookings/bookings-reader/v2/extended-bookings/query' \ -H 'Authorization: <AUTH>' \ -d '{ "query": { "filter": { "bookedEntity.item.slot.sessionId" : ["2mmoW0vwKcSFyxtOfCdKZoL2PDsyWG3fw2loVjs4xCdGebAdETRJyFCbPMBvCs5hidrevMmkVChbcMGNF9RsMDpPSUy0Ew4Kaohh"] }, "paging": null, "sort": [] }, "withBookingAllowedActions": false, "withBookingAttendanceInfo": false, "withBookingConferencingDetails": false, "withBookingPolicySettings": false, "withBookingFeeDetails": false }'
Response
JSON
{ "extendedBookings": [ { "booking": { "id": "42914cf7-4041-48a0-b0e7-d00f2811f968", "bookedEntity": { "slot": { "sessionId": "2mmoW0vwKcSFyxtOfCdKZoL2PDsyWG3fw2loVjs4xCdGebAdETRJyFCbPMBvCs5hidrevMmkVChbcMGNF9RsMDpPSUy0Ew4Kaohh", "eventId": "65a5776e-37f1-45f7-8e4c-f22d01b23254", "serviceId": "6e7f01de-a6d5-4a1c-8b25-87cf7c3cbe81", "scheduleId": "a34331f7-474e-4433-b3f9-13637d114dc4", "startDate": "2021-07-05T13:15:00.000+01:00", "endDate": "2021-07-05T15:15:00.000+01:00", "timezone": "Europe/Dublin", "resource": { "id": "e13a90ac-c4b1-4fbd-969f-7c8fc0310363", "name": "Jane Brown", "email": "Jane@example.com", "scheduleId": "163507aa-6b75-4725-bac3-a61d6a8d2df2" }, "location": { "id": "efaf91d1-72b1-4036-a715-8d848ec1857e", "name": "HOME", "locationType": "OWNER_BUSINESS" } }, "title": "Example Service", "tags": ["INDIVIDUAL"] }, "contactDetails": { "contactId": "5160e721-cfe9-4ad4-986e-76e52f4ab682", "firstName": "Lucien Lamalo", "email": "LucienL@example.com", "timeZone": "Europe/Dublin", "countryCode": "US" }, "additionalFields": [ { "id": "06d592d3-05ef-436f-8dcb-ba806c8984fd", "label": "Example Message", "valueType": "LONG_TEXT" }, { "id": "3c79b439-5300-4a08-add8-8bb810de7b69", "value": "true", "label": "Example Checkbox", "valueType": "CHECK_BOX" } ], "numberOfParticipants": 1, "status": "CONFIRMED", "paymentStatus": "PAID", "selectedPaymentOption": "ONLINE", "createdDate": "2021-06-27T14:18:59.108Z", "bookingSource": { "platform": "WEB", "actor": "CUSTOMER", "appDefId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", "appName": "Wix Bookings" }, "revision": "3", "startDate": "2021-07-05T12:15:00Z", "endDate": "2021-07-05T14:15:00Z", "updatedDate": "2021-06-27T14:19:01.023Z", "totalParticipants": 1 } } ], "pagingMetadata": { "count": 1, "total": 1, "cursors": {}, "hasNext": false } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?