List Events with Wix Events API

Download skill
Copy

This recipe demonstrates how to query and list events from Wix Events using the REST API.

Prerequisites

  • Wix Events app installed on the site
  • API access with events permissions

Required APIs


Step 1: Verify Events App is Installed

Before querying events, ensure Wix Events is installed on the site. If not, use the Install Wix Apps recipe to install it.


Step 2: Query Events

Endpoint: POST https://www.wixapis.com/events/v3/events/query

Request Body:

Copy

Request:

Copy

Available Field Sets

The fields parameter determines which data is returned. You MUST specify at least "DETAILS".

Field SetDescription
DETAILSCore event information (required)
URLSEvent page URLs
CATEGORIESEvent categories
AGENDAEvent schedule/agenda
SEO_SETTINGSSEO metadata
REGISTRATIONRegistration settings
TEXTSCustom text content
FORMRegistration form configuration
DASHBOARDDashboard settings
FEEDSocial feed settings
ONLINE_CONFERENCING_SESSIONVirtual event settings

IMPORTANT NOTES:

  • I MUST specify at least "DETAILS" in the fields array
  • I MUST NEVER use "FULL" as a field value
  • If the user wants event links, I MUST include "URLS" in the fields
  • Follow the Filter and Sort Guidelines for query filtering

Step 3: Filter Events (Optional)

Apply filters to narrow down results:

Filter by Status:

Copy

Note: Valid status values are: UPCOMING, STARTED, ENDED, CANCELED, DRAFT.

Filter by Date Range:

Copy

Response Structure

Copy

Common Use Cases

List Upcoming Events

Copy

List Events with Registration Info

Copy

Next Steps

  • Create events using the Create Event API
  • Manage RSVPs and registrations
  • Configure event tickets and pricing
Did this help?