Get calendar by IDDocumentation Index
Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
GET https://services.leadconnectorhq.com/calendars/{calendarId}
Autorizacion
Bearer token generado desde el portal Leadway. Ver Autenticacion.
Version de la API.
Path parameters
Calendar Id
Respuestas
200 - Successful response
200 - Successful response
Show propiedades
Show propiedades
Should the created calendar be active or draft
🚨 Deprecated! Please use ‘Calendar Notifications APIs’ instead.
Show cada item
Show cada item
Calendar Notification Posibles valores: ‘email’
Comma separated emails
Group Id
Team members are for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.
Show cada item
Show cada item
Posibles valores: 0, 0.5, 1
🚨 Deprecated! Use
locationConfigurations.kind instead. Posibles valores: ‘custom’, ‘zoom’, ‘gmeet’, ‘phone’, ‘address’, ‘teams’, ‘booker’🚨 Deprecated! Use
locationConfigurations.account instead.Marks a user as primary. This property is required in case of collective booking calendars. Only one user can be primary.
Meeting account configurations
Show cada item
Show cada item
Type of meeting account. zoom_conference/google_conference/ms_teams_conference is not supported in event calendar type Posibles valores: ‘custom’, ‘zoom_conference’, ‘google_conference’, ‘inbound_call’, ‘outbound_call’, ‘physical’, ‘booker’, ‘ms_teams_conference’
Address for meeting account. Not applicable on “zoom_conference”, “google_conference” and “ms_teams_conference” kind
Unique ID used to select a specific meeting account
Posibles valores: ‘RoundRobin_OptimizeForAvailability’, ‘RoundRobin_OptimizeForEqualDistribution’
Posibles valores: ‘round_robin’, ‘event’, ‘class_booking’, ‘collective’, ‘service_booking’, ‘personal’
Calendar widget type. Choose “default” for “neo” and “classic” for “classic” layout. Posibles valores: ‘default’, ‘classic’
🚨 Deprecated! Use
locationConfigurations.account or teamMembers[].locationConfigurations.account instead.Meeting account configuration for event calendar
Show cada item
Show cada item
Type of meeting account. zoom_conference/google_conference/ms_teams_conference is not supported in event calendar type Posibles valores: ‘custom’, ‘zoom_conference’, ‘google_conference’, ‘inbound_call’, ‘outbound_call’, ‘physical’, ‘booker’, ‘ms_teams_conference’
Address for meeting account. Not applicable on “zoom_conference”, “google_conference” and “ms_teams_conference” kind
Unique ID used to select a specific meeting account
This controls the duration of the meeting
Unit for slot duration. Posibles valores: ‘mins’, ‘hours’
Slot interval reflects the amount of time the between booking slots that will be shown in the calendar.
Unit for slot interval. Posibles valores: ‘mins’, ‘hours’
Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up
Unit for slot buffer. Posibles valores: ‘mins’, ‘hours’
Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
Unit for pre-buffer. Posibles valores: ‘mins’, ‘hours’
Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar.
Number of appointments that can be booked for a given day
Minimum scheduling notice for events
Unit for minimum scheduling notice Posibles valores: ‘hours’, ‘days’, ‘weeks’, ‘months’
Minimum number of days/weeks/months for which to allow booking events
Unit for controlling the duration for which booking would be allowed for Posibles valores: ‘days’, ‘weeks’, ‘months’
Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this
Show propiedades
Show propiedades
Posibles valores: ‘DAILY’, ‘WEEKLY’, ‘MONTHLY’
Number of recurrences
This setting contols what to do incase a recurring slot is unavailable Posibles valores: ‘skip’, ‘continue’, ‘book_next’
This setting contols what to do incase a recurring slot is unavailable Posibles valores: ‘confirmed’, ‘new’
Posibles valores: ‘RedirectURL’, ‘ThankYouMessage’
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. Posibles valores: 0, 1
This is only to set the custom availability. For standard availability, use the openHours property
Show cada item
Show cada item
Posibles valores: ‘count_only’, ‘collect_detail’
Look Busy Configuration
{
"calendar": {
"isActive": true,
"notifications": [
{
"type": "email",
"shouldSendToContact": true,
"shouldSendToGuest": true,
"shouldSendToUser": true,
"shouldSendToSelectedUsers": true,
"selectedUsers": "user1@testemail.com,user2@testemail.com"
}
],
"locationId": "ocQHyuzHvysMo5N5VsXc",
"groupId": "BqTwX8QFwXzpegMve9EQ",
"teamMembers": [
{
"userId": "ocQHyuzHvysMo5N5VsXc",
"priority": 0.5,
"meetingLocationType": "custom",
"meetingLocation": "string",
"isPrimary": true,
"locationConfigurations": []
}
],
"eventType": "RoundRobin_OptimizeForAvailability",
"name": "test calendar",
"description": "this is used for testing",
"slug": "test1",
"widgetSlug": "test1",
"calendarType": "round_robin",
"widgetType": "classic",
"eventTitle": "{{contact.name}}",
"eventColor": "#039be5",
"meetingLocation": "string",
"locationConfigurations": [
{
"kind": "custom",
"location": "string",
// truncado: 60 lineas mas
}
400 - Bad Request
400 - Bad Request
{}
401 - Unauthorized
401 - Unauthorized
{}
Ejemplo
curl -X GET 'https://services.leadconnectorhq.com/calendars/YOUR_calendarId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'