POST

Query Events


Retrieves a list of events, given the provided paging, filtering, and sorting. Query Events runs with these defaults, which you can override:

Note: You need to pass the paging field in the request to get the items in the response.

Permissions
Manage Bookings Services and Settings
Manage Challenges
Access Verticals by Automations
Set Up Automations
Manage Events - all permissions
Read Events - all read permissions
Manage Events
Manage Guest List
Read Events
Manage Events
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v3/events/query

Body Params
queryQuery

Query options. See API Query Language for more details.


fieldsArray <string>maxItems 20

Predefined sets of fields to return.


includeDraftsboolean

Whether draft events should be returned in the response.
Note: This parameter requires the WIX_EVENTS.READ_DRAFT_EVENTS permission.

Response Object
pagingMetadataPagingMetadata

Metadata for the paginated results.


eventsArray <Event>

List of events.

Query events by status with registration details
Request
cURL
Response
JSON
Errors
400Invalid Argument

There is 1 error with this status code.

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

Did this help?