GET

List Calendars

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 calendars belonging to the connected external calendar account.

Note: Before using this endpoint, establish a connection with an external calendar using Connect By Credentials or Connect By OAuth.

Authentication

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

Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/bookings/v2/external-calendars/connections/{connectionId}/calendars
Path Params
connectionIdstringRequired

ID of the external calendar connection to list calendars for.

Response Object
calendarsArray <Calendar>

List of calendars belonging to the external calendar account.

List calendars belonging to an external calendar account
Request
cURL
curl -X GET 'https://www.wixapis.com/bookings/v2/external-calendars/connections/4WnvD8QzxhkAjVPBKUCvLIMpbuuUCMID7rYhqOpIGDae9JYyQj0JS71sdJukve86B38sWvS6TOvMQqBxszjEMNrrx8EGfFr5KhzpkCmfjBNJx2MSLZEkgEzGqEHtRYJ92LTUJ2w5v87FG2DafDaN3VSfbRlvSEqzXlgbEapLhGsm976gGw90KJd/calendars' \
-H 'Authorization: <AUTH>'
Response
JSON
{
  "calendars": [
    {
      "id": "a68yu6lp6584z66zorp19z1ab",
      "name": "Home"
    },
    {
      "id": "4xve0tohyhnrlzy3lp4zf7b07",
      "name": "Work"
    }
  ]
}
Errors
403Permission Denied

There is 1 error with this status code.

428Failed Precondition

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?