queryExperiences( )

Developer Preview

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

Retrieves a list of experiences using the specified paging, filtering, and sorting.

For a detailed list of supported operations, see the Supported Filters and Sorting article. To learn how to query reservation locations, see API Query Language.

PROPERTY	SUPPORTED FILTERS & SORTING
`_id`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`gt()`,`lt()`,`le()`,`ge()`,`ascending()`,`descending()`
`reservationLocationId`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`gt()`,`lt()`,`le()`,`ge()`,`ascending()`,`descending()`
`_createdDate`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`lt()`,`le()`,`gt()`,`ge()`,`ascending()`,`descending()`
`_updatedDate`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`lt()`,`le()`,`gt()`,`ge()`,`ascending()`,`descending()`
`configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`gt()`,`lt()`,`le()`,`ge()`,`ascending()`,`descending()`
`configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`gt()`,`lt()`,`le()`,`ge()`,`ascending()`,`descending()`
`configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`gt()`,`lt()`,`le()`,`ge()`,`ascending()`,`descending()`
`configuration.visible`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`
`tags.privateTags.tagIds`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`hasAll()`,`ascending()`,`descending()`
`tags.publicTags.tagIds`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`hasAll()`,`ascending()`,`descending()`

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

In Wix sites and Wix apps, use elevated permissions.
In Wix Headless projects, use API key authentication.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Request

This method does not take any parameters

Returns

Return Type:ExperiencesQueryBuilder

Errors

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

Did this help?