POST

Query Events


Retrieves a list of events, given the provided paging, filtering, and sorting.

Defaults

Query Events runs with these defaults, which you can override:

  • Sorted by start in ASC order.
  • cursorPaging.limit is 50.

Filters

For field support for filters and sorting, see Calendar Events V3: Supported Filters and Sorting (REST).

Date filters

Do not specify filters for start and end dates inside query.filter, instead specify fromLocalDate and toLocalDate.

Unsupported filters

You can't filter by the following fields:

  • eventId: To query by event ID call either Get Event (SDK | REST) or List Events (SDK | REST).
  • contactId: To query by a participant's contact ID call List Events by Contact ID (SDK | REST).
  • memberId: To query by a participant's member ID call [List Events by Member ID (SDK | REST).

See also

To learn about working with Query endpoints, see:

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Read Bookings Calendar Availability
Read bookings calendar - including participants
Read Bookings Calendar
Manage Calendars
Read Calendar - Including PI
Read Calendar
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/calendar/v3/events/query

Errors

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

Did this help?