Get Calendar

GEThttps://services.leadconnectorhq.com/calendars/{calendarId}/free-slots
Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Path Parameters
calendarId
string
required

Calendar Id

Example:
ocQHyuzHvysMo5N5VsXc
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-04-15

Responses

Successful response

Body

calendar
object
required
isActive
boolean

Should the created calendar be active or draft

Default:
true
notifications
array[object]
deprecated

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

locationId
string
required
Example:
ocQHyuzHvysMo5N5VsXc
groupId
string

Group Id

Example:
BqTwX8QFwXzpegMve9EQ
teamMembers
array[object]

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

eventType
string
Allowed values:
RoundRobin_OptimizeForAvailabilityRoundRobin_OptimizeForEqualDistribution
Default:
RoundRobin_OptimizeForAvailability
name
string
required
Example:
test calendar
description
string
Example:
this is used for testing
slug
string
Example:
test1
widgetSlug
string
Example:
test1
calendarType
string
Allowed values:
round_robineventclass_bookingcollectiveservice_bookingpersonal
widgetType
string

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

Allowed values:
defaultclassic
Default:
classic
Example:
classic
eventTitle
string
Default:
{{contact.name}}
eventColor
string
Default:
#039be5
meetingLocation
string
deprecated

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

locationConfigurations
array[object]

Meeting location configuration for event calendar

slotDuration
number

This controls the duration of the meeting

Default:
30
slotDurationUnit
string

Unit for slot duration.

Allowed values:
minshours
slotInterval
number

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

Default:
30
slotIntervalUnit
string

Unit for slot interval.

Allowed values:
minshours
slotBuffer
number

Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up

slotBufferUnit
string

Unit for slot buffer.

Allowed values:
minshours
preBuffer
number

Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready

preBufferUnit
string

Unit for pre-buffer.

Allowed values:
minshours
appoinmentPerSlot
number

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

Default:
1
appoinmentPerDay
number

Number of appointments that can be booked for a given day

allowBookingAfter
number

Minimum scheduling notice for events

allowBookingAfterUnit
string

Unit for minimum scheduling notice

Allowed values:
hoursdaysweeksmonths
Example:
days
allowBookingFor
number

Minimum number of days/weeks/months for which to allow booking events

allowBookingForUnit
string

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

Allowed values:
daysweeksmonths
Example:
days
openHours
array[object]

This is only to set the standard availability. For custom availability, use the availabilities property

enableRecurring
boolean

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

Default:
false
recurring
object
formId
string
stickyContact
boolean
isLivePaymentMode
boolean
autoConfirm
boolean
Default:
true
shouldSendAlertEmailsToAssignedMember
boolean
alertEmail
string
googleInvitationEmails
boolean
Default:
false
allowReschedule
boolean
Default:
true
allowCancellation
boolean
Default:
true
shouldAssignContactToTeamMember
boolean
shouldSkipAssigningContactForExisting
boolean
notes
string
pixelId
string
formSubmitType
string
Allowed values:
RedirectURLThankYouMessage
Default:
ThankYouMessage
formSubmitRedirectURL
string
formSubmitThanksMessage
string
availabilityType
number

Determines which availability type to consider:

  • 1: Only custom availabilities will be used.
  • 0: Only open hours will be used.
  • null: Both custom availabilities and open hours will be considered.
Allowed values:
01
availabilities
array[object]

This is only to set the custom availability. For standard availability, use the openHours property

guestType
string
Allowed values:
count_onlycollect_detail
consentLabel
string
calendarCoverImage
string
Example:
https://path-to-image.com
lookBusyConfig
object

Look Busy Configuration

id
string
required
Example:
0TkCdp9PfvLeWKYRRvIz

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request