Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

Calendar

calendar

ID of resource holding the schedule synced to the external calendar.

resourceId

start

ExternalCalendarEvent

ListEventsRequest

events

ListEventsResponse

limit

Number of items to skip in the current sort order.

offset

Paging

Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.

fields

Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.

fieldsets

Filter object in the following format:
`"filter" : {
"fieldName1": "value1",
"fieldName2":{"$operator":"value2"}
}`
Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`

filter

Paging options to limit and skip the number of items.

Sort object in the following format:
`[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`

sort

Query

value

Int32Value

values

ListValue

NullValue

StringValue

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

SortOrder

fieldName

order

Sorting

> **Deprecation Notice**
>
> **This endpoint has been replaced with External Calendar V2's[List Events](https://dev.wix.com/api/rest/wix-bookings/external-calendars-v2/list-events) and will be removed on December 31, 2023.**
> **If your app uses this endpoint, we recommend updating your code as soon as possible.**

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.

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

Lists External Calendar Events

ListEvents

Event