queryBookingForms( )


Retrieves a list of up to 100 booking forms, and information about the services that are connected to them, given the provided filtering, paging, and sorting.

Defaults

Query Booking Forms has the following default settings, which you can override:

  • Sorted by id in ascending order.
  • cursorPaging.limit set to 100.

Filters

For a complete list of supported filters, refer to Forms API: Supported Filters.

When using date filters, you must use UTC time.

Returned services

If a booking policy is connected to more than 5 services, only a subset of these service IDs and names is returned. The bookingForms.totalServiceCount values indicate the total number of services linked to each form. You can call Query Services and specify the relevant form ID in the filter to retrieve all services connected to the booking form.

Default booking forms

By default, all Wix Bookings services use a standard booking form. To retrieve a site's default booking form with Query Booking Forms, specify {"conditionalFields": ["DEFAULT_BOOKING_FORM"]}.

See also

To learn about working with Query methods, see API Query Language and Sorting and Paging.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings
Wix Multilingual - Nile Wrapper Domain Events Read
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
queryCursorQueryRequired

Information about filters, paging, and sorting. See the article about form filters (REST) for all supported filters and sorting options.


optionsQueryBookingFormsOptions
Returns
Return Type:Promise<QueryBookingFormsResponse>
Errors
404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?