POST

Query Events


Developer Preview

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

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

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

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

You can't filter by event ID. To query by event ID, use Get Event or List Events.

You can't filter by contact or member ID. To query by a participant's contact or member ID, use List Events by Contact ID or List Events by Member ID.

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

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

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

Body Params
fromLocalDatestringformat LOCAL_DATE_TIME

Local start date and time from which events are returned in ISO-8601 format. For example, 2024-01-30T13:30:00.

Events that start before the fromLocalDate but end after it are included in the results. Must be earlier than toLocalDate unless the sort order is descending.


toLocalDatestringformat LOCAL_DATE_TIME

Local end date and time up to which events are returned in ISO-8601 format. For example, 2024-01-30T13:30:00.

Events that start before toLocalDate but end after it are included in the results. Must be later than fromLocalDate unless the sort order is descending.


timeZonestring

Time zone in IANA tz database format for fromLocalDate, toLocalDate, and for calculating adjustedStart and adjustedEnd. For example, America/New_York or UTC.

Default: timeZone specified in the business site properties.


queryQuery

Query containing filters and paging.


recurrenceTypeArray <string>maxItems 5

Filters events based on their recurrenceType.

Max: 5 recurrence types can be specified. Default: Events with recurrenceType of NONE, INSTANCE, and EXCEPTION are returned.


fieldsArray <string>maxItems 1

Information about which fields containing personal data to return. Refer to the permissions article for more information.

Supported values:

  • PI_FIELDS: Returns all fields with personal data. Your app must have Read Calendars - Including PI or Manage Calendars permission scope.
  • OWN_PI_FIELDS: Returns only fields containing your own personal data.

Max: 1 field Default: No personal data is returned.

Response Object
eventsArray <Event>

Retrieved events matching the provided query.


pagingMetadataPagingMetadata

Paging metadata.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/calendar/v3/events/query' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "fromLocalDate": "2024-10-01T00:00:00", "toLocalDate": "2024-10-28T23:59:59", }'
Response
JSON
{ "events": [ { "id": "WqKyhiYgLmblyVmHFnjazbmCJKK01ACZM79rgdVqUHjcIrX84YfDON2IdaFegGtRpk1wger3lHBXTvzXqrCCoZSzauJtGzjfam5hcT4q4qCTx3CctxC6D2", "scheduleId": "37e01b7f-7137-4c06-bca5-02eb435c1503", "externalScheduleId": "38e25e56-d50f-42b4-a3b6-aa04c61dded1", "scheduleName": "Full Body Strength", "type": "CLASS", "status": "CONFIRMED", "title": "Full Body Strength", "start": { "localDate": "2024-10-07T09:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T08:00:00Z" }, "end": { "localDate": "2024-10-07T10:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T09:00:00Z" }, "adjustedStart": { "localDate": "2024-10-07T09:00:00", "timeZone": "Europe/Dublin" }, "adjustedEnd": { "localDate": "2024-10-07T10:00:00", "timeZone": "Europe/Dublin" }, "timeZone": "Europe/Dublin", "recurrenceType": "INSTANCE", "recurrenceRule": { "frequency": "WEEKLY", "interval": 1, "days": ["MONDAY"] }, "recurringEventId": "37e01b7f71374c06bca502eb435c150373f9e893914546b795978fe3de3e49f7", "transparency": "OPAQUE", "location": { "type": "BUSINESS" }, "resources": [ { "id": "76570209-101f-409b-af97-b445bdb63125", "name": "Staff Member #1", "type": "1cd44cf8-756f-41c3-bd90-3e2ffcaf1155", "scheduleId": "e73bf671-bb59-4488-8d1f-afcf0ebe8d27", "transparency": "OPAQUE", "permissionRole": "WRITER" } ], "totalCapacity": 50, "remainingCapacity": 50, "inheritedFields": [ "TITLE", "CAPACITY", "LOCATION", "TIME_ZONE", "CONFERENCING_DETAILS", "RESOURCES", "PARTICIPANTS", "TIME" ], "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", "permissions": [], "revision": "1", "createdDate": "2024-10-06T17:16:36.345Z", "updatedDate": "2024-10-06T17:16:36.345Z" }, { "id": "VYAN5iNZkOn1SQ5LLJVWXxdGqRfcnyxpZ2STCAr7l6RswqhNAvAXfO7o59cEoDfhwVTtXUIhN6JM5bb7MDprhwwf3DPqQ6CBgry0qfF6OfXn1tEEqMcwPA", "scheduleId": "132db383-1378-4903-820b-4eebf4242de2", "externalScheduleId": "4187d1f3-38a2-4cfd-b8f1-6333cd012e33", "scheduleName": "Hip Hop Groove", "type": "CLASS", "status": "CONFIRMED", "title": "Hip Hop Groove", "start": { "localDate": "2024-10-07T11:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T10:00:00Z" }, "end": { "localDate": "2024-10-07T12:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T11:00:00Z" }, "adjustedStart": { "localDate": "2024-10-07T11:00:00", "timeZone": "Europe/Dublin" }, "adjustedEnd": { "localDate": "2024-10-07T12:00:00", "timeZone": "Europe/Dublin" }, "timeZone": "Europe/Dublin", "recurrenceType": "INSTANCE", "recurrenceRule": { "frequency": "WEEKLY", "interval": 1, "days": ["MONDAY"] }, "recurringEventId": "132db38313784903820b4eebf4242de24cb655131b0f4f359b7345e7daabb34d", "transparency": "OPAQUE", "location": { "type": "BUSINESS" }, "resources": [ { "id": "76570209-101f-409b-af97-b445bdb63125", "name": "Staff Member #1", "type": "1cd44cf8-756f-41c3-bd90-3e2ffcaf1155", "scheduleId": "e73bf671-bb59-4488-8d1f-afcf0ebe8d27", "transparency": "OPAQUE", "permissionRole": "WRITER" } ], "totalCapacity": 50, "remainingCapacity": 50, "inheritedFields": [ "TITLE", "CAPACITY", "LOCATION", "TIME_ZONE", "CONFERENCING_DETAILS", "RESOURCES", "PARTICIPANTS", "TIME" ], "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", "permissions": [], "revision": "1", "createdDate": "2024-10-06T17:16:36.117Z", "updatedDate": "2024-10-06T17:16:36.117Z" } ], "pagingMetadata": { "count": 2, "hasNext": false } }
Errors

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

Did this help?