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 Events - all permissions
Read Events - all read permissions
Read Events
Manage Guest List
Manage Portfolio
Manage Restaurants - all permissions
Manage Events
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
curl -X POST 'https://www.wixapis.com/events/v3/events/query' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "query": { "filter": { "status": { "$ne": "CANCELED" } }, "paging": { "limit": 2 } }, "fields": ["DETAILS", "TEXTS", "REGISTRATION", "URLS", "FORM", "DASHBOARD", "ONLINE_CONFERENCING_SESSION", "SEO_SETTINGS", "AGENDA", "CATEGORIES"], "includeDrafts": false }'
Response
JSON
{ "pagingMetadata": { "count": 2, "offset": 0, "total": 10, "tooManyToCount": null, "cursors": null, "hasNext": null }, "events": [ { "id": "1a5f4463-e484-4d03-b40f-8783bf3c16fb", "location": { "name": "Le Cordon Bleu Paris", "type": "VENUE", "address": { "country": "FR", "subdivision": null, "city": "Paris", "postalCode": "75015", "streetAddress": { "number": "13-15", "name": "Quai André Citroën", "apt": "", "formattedAddressLine": null }, "addressLine2": null, "formattedAddress": "13-15 Quai André Citroën, 75015 Paris, France", "hint": null, "geocode": { "latitude": 48.84830129999999, "longitude": 2.2810077 }, "countryFullname": "France", "subdivisions": [ { "code": "IDF", "name": "Île-de-France", "type": "ADMINISTRATIVE_AREA_LEVEL_1", "typeInfo": null }, { "code": "Département de Paris", "name": "Département de Paris", "type": "ADMINISTRATIVE_AREA_LEVEL_2", "typeInfo": null }, { "code": "Paris", "name": "Paris", "type": "ADMINISTRATIVE_AREA_LEVEL_3", "typeInfo": null }, { "code": "FR", "name": "France", "type": "COUNTRY", "typeInfo": null } ], "subdivisionFullname": null }, "locationTbd": false }, "dateAndTimeSettings": { "dateAndTimeTbd": false, "dateAndTimeTbdMessage": null, "startDate": "2023-10-20T08:00:00Z", "endDate": "2023-10-22T16:00:00Z", "timeZoneId": "Europe/Paris", "hideEndDate": false, "showTimeZone": true, "recurrenceStatus": "ONE_TIME", "recurringEvents": { "individualEventDates": [], "categoryId": null }, "formatted": { "dateAndTime": "20 October 2023 at 10:00 – 22 October 2023 at 18:00 GMT+2", "startDate": "20 October 2023", "startTime": "10:00", "endDate": "22 October 2023", "endTime": "18:00" } }, "title": "Culinary Fusion: A Gastronomic Adventure", "shortDescription": "", "mainImage": null, "slug": "culinary-fusion-a-gastronomic-adventure", "languageCode": "en", "createdDate": "2023-07-12T12:40:56.315Z", "updatedDate": "2023-07-12T12:42:32Z", "status": "UPCOMING", "registration": { "type": "TICKETING", "status": "OPEN_TICKETS", "rsvp": { "responseType": "YES_ONLY", "limit": null, "waitlistEnabled": false, "startDate": null, "endDate": null }, "tickets": { "guestsAssignedSeparately": false, "ticketLimitPerOrder": 50, "stockManagerAppId": null, "currency": "EUR", "lowestPrice": { "value": "80.00", "currency": "EUR", "formattedValue": "€80" }, "highestPrice": { "value": "80.00", "currency": "EUR", "formattedValue": "€80" }, "soldOut": false, "taxSettings": null }, "external": null, "allowedGuestTypes": "VISITOR_OR_MEMBER", "initialType": "TICKETING", "registrationPaused": false, "registrationDisabled": false }, "calendarUrls": null, "eventPageUrl": null, "form": null, "summaries": null, "instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b", "guestListSettings": { "displayedPublicly": true }, "userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "feed": null, "onlineConferencing": { "enabled": false, "providerId": null, "providerName": "", "type": -1, "session": null }, "seoSettings": null, "contactLabel": "custom.culinary-fusion-a-gastronomic-adventure-10-20-23-1", "agendaSettings": null, "categories": [] }, { "id": "88e3ccdb-cab7-48e1-85a9-1d4a9430357f", "location": { "name": "San Jose Convention Center", "type": "VENUE", "address": { "country": "US", "subdivision": "CA", "city": "San Jose", "postalCode": "95113", "streetAddress": { "number": "150", "name": "West San Carlos Street", "apt": "", "formattedAddressLine": null }, "addressLine_2": null, "formattedAddress": "150 W San Carlos St, San Jose, CA 95113, USA", "hint": null, "geocode": { "latitude": 37.3284838, "longitude": -121.8881933 }, "countryFullName": "United States", "subdivisions": [ { "code": "CA", "name": "California", "type": "ADMINISTRATIVE_AREA_LEVEL_1", "typeInfo": null }, { "code": "Santa Clara County", "name": "Santa Clara County", "type": "ADMINISTRATIVE_AREA_LEVEL_2", "typeInfo": null }, { "code": "San Jose", "name": "San Jose", "type": "ADMINISTRATIVE_AREA_LEVEL_3", "typeInfo": null }, { "code": "Downtown San Jose", "name": "Downtown San Jose", "type": "ADMINISTRATIVE_AREA_LEVEL_4", "typeInfo": null }, { "code": "US", "name": "United States", "type": "COUNTRY", "typeInfo": null } ], "subdivisionFullname": null }, "locationTbd": false }, "dateAndTimeSettings": { "dateAndTimeTbd": false, "dateAndTimeTbdMessage": null, "startDate": "2023-07-26T16:00:00Z", "endDate": "2023-07-27T16:00:00Z", "timeZoneId": "America/Yellowknife", "hideEndDate": false, "showTimeZone": false, "recurrenceStatus": "ONE_TIME", "recurringEvents": { "individualEventDates": [], "categoryId": null }, "formatted": { "dateAndTime": "26 July 2023 at 10:00 – 27 July 2023 at 10:00", "startDate": "26 July 2023", "startTime": "10:00", "endDate": "27 July 2023", "endTime": "10:00" } }, "title": "TechXpo 2023: Innovation and Future Trends Unveiled (1)", "shortDescription": "", "mainImage": null, "slug": "techxpo-2023-innovation-and-future-trends-unveiled-1", "languageCode": "en", "createdDate": "2023-07-12T11:14:22.410Z", "updatedDate": "2023-07-12T11:14:22Z", "status": "UPCOMING", "registration": { "type": "RSVP", "status": "OPEN_RSVP", "rsvp": { "responseType": "YES_ONLY", "limit": null, "waitlistEnabled": false, "startDate": null, "endDate": null }, "tickets": { "guestsAssignedSeparately": false, "ticketLimitPerOrder": 50, "stockManagerAppId": null, "currency": null, "lowestPrice": null, "highestPrice": null, "soldOut": true, "taxSettings": null }, "external": null, "allowedGuestTypes": "VISITOR_OR_MEMBER", "initialType": "RSVP", "registrationPaused": false, "registrationDisabled": false }, "calendarUrls": null, "eventPageUrl": null, "form": null, "summaries": null, "instanceId": "1f6dc906-803d-4650-83f5-72ea1d88100b", "guestListSettings": { "displayedPublicly": true }, "userId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "feed": null, "onlineConferencing": { "enabled": false, "providerId": null, "providerName": "", "type": -1, "session": null }, "seoSettings": null, "contactLabel": "custom.techxpo-2023-innovation-and-future-trends-unveil-1", "agendaSettings": null, "categories": [] } ], "facets": {} }
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?