GET

Get Schedule


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 schedule.

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
GET
https://www.wixapis.com/calendar/v3/schedules/{scheduleId}

Path Params
scheduleIdstringRequired

ID of the schedule to retrieve.

Query Params
fieldsArray <string>

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
scheduleSchedule

Retrieved schedule.

Get Schedule
Request
cURL
curl -X GET \ 'https://www.wixapis.com/calendar/v3/schedules/37e01b7f-7137-4c06-bca5-02eb435c1503' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "schedule": { "id": "37e01b7f-7137-4c06-bca5-02eb435c1503", "externalId": "38e25e56-d50f-42b4-a3b6-aa04c61dded1", "name": "Full Body Strength", "status": "ACTIVE", "timeZone": "Europe/Dublin", "businessTimeZoneEnabled": true, "defaultTitle": "Full Body Strength", "defaultLocation": { "type": "BUSINESS" }, "defaultCapacity": 50, "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", "permissions": [], "revision": "1", "createdDate": "2024-10-06T17:16:35.386Z", "updatedDate": "2024-10-06T17:16:35.386Z" } }
Errors

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

Did this help?