CalendarsVersion: v3

Get Calendar

GET/calendars/{calendarId}

Get calendar by ID

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:calendars.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

calendarIdstringrequired

Calendar Id

Example:ocQHyuzHvysMo5N5VsXc

Response

application/json

Successful response

calendarobjectrequired

Calendar details

calendar.isActiveboolean

Should the created calendar be active or draft

Default:true

Example:true

calendar.notificationsobject[]deprecated

🚨 Deprecated! Please use 'Calendar Notifications APIs' instead.

calendar.locationIdstringrequired

Location ID

Example:ocQHyuzHvysMo5N5VsXc

calendar.groupIdstring

Group Id

Example:BqTwX8QFwXzpegMve9EQ

calendar.teamMembersobject[]

Team members are for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.

calendar.eventTypestring

Event type for round robin distribution

Available optionsRoundRobin_OptimizeForAvailabilityRoundRobin_OptimizeForEqualDistribution

Example:RoundRobin_OptimizeForAvailability

calendar.namestringrequired

Calendar name

Example:test calendar

calendar.descriptionstring

Calendar description

Example:this is used for testing

calendar.slugstring

Legacy calendar slug. The booking page does not read it: set widgetSlug to change the booking link.

Example:test1

calendar.widgetSlugstring

Booking link slug: the booking page URL ends with /widget/bookings/{widgetSlug}. Must be unique.

Example:test1

calendar.calendarTypestring

Calendar type

Available optionsround_robineventclass_bookingcollectiveservice_bookingpersonal

Example:round_robin

calendar.widgetTypestring

Calendar widget type. Choose "default" for "neo" and "classic" for "classic" layout.

Available optionsdefaultclassic

Example:classic

calendar.eventTitlestring

Title for calendar events

Default:{{contact.name}}

Example:{{contact.name}}

calendar.eventColorstring

Color for calendar events in hex format

Default:#039be5

Example:#039BE5

calendar.meetingLocationstringdeprecated

🚨 Deprecated! Use locationConfigurations.location or teamMembers[].locationConfigurations.location instead.

calendar.locationConfigurationsobject[]

Meeting location configuration for event calendar

calendar.slotDurationnumber

This controls the duration of the meeting

Possible values: >= 1

Default:30

Example:30

calendar.slotDurationUnitstring

Unit for slot duration.

Available optionsminshours

Example:mins

calendar.durationOptionsobject[]

Multiple duration options for the calendar. Bookers can select their preferred meeting length. Max 3 options. Exactly one must be marked as default.

calendar.slotIntervalnumber

Slot interval reflects the amount of time the between booking slots that will be shown in the calendar.

Possible values: >= 1

Default:30

Example:30

calendar.slotIntervalUnitstring

Unit for slot interval.

Available optionsminshours

Example:mins

calendar.slotBuffernumber

Buffer after each meeting: extra time blocked after an appointment, to wrap up. Unit: slotBufferUnit.

Example:15

calendar.slotBufferUnitstring

Unit for slot buffer.

Available optionsminshours

Example:mins

calendar.preBuffernumber

Buffer before each meeting: extra time blocked before an appointment, to get ready. Unit: preBufferUnit.

Example:10

calendar.preBufferUnitstring

Unit for pre-buffer.

Available optionsminshours

Example:mins

calendar.appoinmentPerSlotnumber

Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar.

Default:1

Example:1

calendar.appoinmentPerDaynumber

Daily booking limit (unset = no limit).

Example:8

calendar.allowBookingAfternumber

Minimum scheduling notice before a booking (unit: allowBookingAfterUnit). 0 = no minimum.

Example:4

calendar.allowBookingAfterUnitstring

Unit for minimum scheduling notice

Available optionshoursdaysweeksmonthsmins

Example:days

calendar.allowBookingFornumber

Booking window: how far ahead bookings are allowed (unit: allowBookingForUnit). 0 = no limit.

Example:30

calendar.allowBookingForUnitstring

Unit for controlling the duration for which booking would be allowed for

Available optionsdaysweeksmonths

Example:days

calendar.countAvailableDaysOnlyboolean

When true, only days with configured availability count toward the date range booking window

Default:false

Example:false

calendar.openHoursobject[]deprecated

While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.

calendar.enableRecurringboolean

Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this

Default:false

Example:false

calendar.recurringobject

Recurring appointment configuration

calendar.formIdstring

Form ID to be used for booking

Example:YlWd2wuCAZQzh2cH1fVZ

calendar.stickyContactboolean

Enable sticky contact assignment

Example:true

calendar.isLivePaymentModeboolean

Whether payment mode is live

Example:false

calendar.autoConfirmboolean

Auto-confirm appointments

Default:true

Example:true

calendar.shouldSendAlertEmailsToAssignedMemberboolean

Send alert emails to assigned team member

Example:false

calendar.alertEmailstring

Alert email address

Example:[email protected]

calendar.googleInvitationEmailsboolean

Send Google invitation emails

Default:false

Example:true

calendar.allowRescheduleboolean

Allow rescheduling of appointments

Default:true

Example:true

calendar.allowCancellationboolean

Allow cancellation of appointments

Default:true

Example:true

calendar.shouldAssignContactToTeamMemberboolean

Assign contact to team member on booking

Example:true

calendar.shouldSkipAssigningContactForExistingboolean

Skip assigning contact if contact already exists

Example:false

calendar.notesstring

Notes for the calendar

Example:Please arrive 10 minutes early.

calendar.pixelIdstring

Facebook Pixel ID for tracking

Example:1234567890

calendar.formSubmitTypestring

Action after form submission

Available optionsRedirectURLThankYouMessage

Example:ThankYouMessage

calendar.formSubmitRedirectURLstring

Redirect URL after form submission

Example:https://example.com/thank-you

calendar.formSubmitThanksMessagestring

Thank you message displayed after form submission

Example:Thank you for booking!

calendar.availabilityTypenumberdeprecated

While we will support this property for backward compatibility, it is not required anymore.

Available options01

Example:0

calendar.availabilitiesobject[]deprecated

While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.

calendar.guestTypestring

Type of guest allowed

Available optionscount_onlycollect_detail

Example:count_only

calendar.consentLabelstring

Consent label text

Example:I confirm that I want to receive content from this company using any contact information I provide.

calendar.calendarCoverImagestring

Calendar cover image URL

Example:https://path-to-image.com

calendar.lookBusyConfigobject

Look Busy Configuration

calendar.idstringrequired

Calendar ID

Example:0TkCdp9PfvLeWKYRRvIz

calendar.appointmentPerSlotnumber

Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar.

Default:1

Example:1

calendar.appointmentPerDaynumber

Daily booking limit: appointments that can be booked per day. Unset = no limit; 0 allows none.

Example:8

Get Calendar

Authorizations

Request​

Headers

Path Parameters

Response

Request