Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

List Events

Developer Preview

Lists the events pulled from the external calendar given the provided paging and filtering.
Query object support:

  • filter: supports
    • start: query range end time. Required.
    • end: query range end time. Required.
    • resourceId: The external resource Id to which the external calendar is synced.
  • fields: not supported.
  • paging: not supported.
  • fieldsets: not supported.

Permissions
This endpoint requires the Manage Bookings permission scope.

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

POST

https://www.wixapis.com/bookings/v1/externalCalendar/events

Body Params

NAME
TYPE
DESCRIPTION
query
Required

object

Response Object

NAME
TYPE
DESCRIPTION
events

Array<object>

External calendar events.

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Lists External Calendar Events

Returns all external calendar events of the calendar of the provided resource, within the given time range.

Request

curl

Copy Code
1curl -X POST \
2 'https://www.wixapis.com/bookings/v1/externalCalendar/events' \
3 -H "Content-Type: application/json" \
4 -H 'Authorization: <AUTH>' \
5 --data '{
6 "query": {
7 "filter": "{\"start\": \"2019-08-29T00:00:00.373Z\", \"end\": \"2019-12-30T12:43:58.373Z\", \"resourceId\": [\"0effc651-f74d-4969-b548-29ea0290aa62\"]}"
8 }
9 }'

Response

json

1
2{"events": [
3 {
4 "resourceId": "0effc651-f74d-4969-b548-29ea0290aa62",
5 "calendar": "GOOGLE",
6 "start": "2019-10-10T12:00:00Z",
7 "end": "2019-10-10T13:00:00Z"
8 },
9 {
10 "resourceId": "0effc651-f74d-4969-b548-29ea0290aa62",
11 "calendar": "GOOGLE",
12 "start": "2019-11-11T11:00:00Z",
13 "end": "2019-11-11T12:30:00Z"
14 },
15 {
16 "resourceId": "0effc651-f74d-4969-b548-29ea0290aa62",
17 "calendar": "GOOGLE",
18 "start": "2019-11-13T14:30:00Z",
19 "end": "2019-11-13T15:30:00Z"
20 },
21 {
22 "resourceId": "0effc651-f74d-4969-b548-29ea0290aa62",
23 "calendar": "GOOGLE",
24 "start": "2019-11-27T14:00:00Z",
25 "end": "2019-11-27T15:30:00Z"
26 }
27]}