queryParticipations( )


Developer Preview

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

Creates a query to retrieve a list of participations.

The queryParticipations() function builds a query to retrieve a list of participations and returns a ParticipationsQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() function.

You can refine the query by chaining ParticipationsQueryBuilder functions onto the query. ParticipationsQueryBuilder functions enable you to sort, filter, and control the results that queryParticipations() returns.

queryParticipations() runs with the following ParticipationsQueryBuilder default that you can override:

  • limit is 50.
  • Sorted by createdDate in ascending order.

The functions that are chained to queryParticipations() are applied in the order they are called.

The following ParticipationsQueryBuilder functions are supported for the queryParticipations() function. For a full description of the participations object, see the object returned for the items property in ParticipationsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
scheduleIdeq(),in()
eventIdeq(),in()
_idin()
externalIdeq(),in()
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 - all permissions
Manage Bookings
Manage Calendars
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Errors

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

Did this help?