Get Calendars - Leadway API

Get all calendars in a account.

GET https://services.leadconnectorhq.com/calendars/

Autorización

Authorization

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

Version

string

default:"2021-07-28"

required

Versión de la API.

Query parameters

locationId

string

default:"ve9EPM428h8vShlRW1KT"

required

Account Id

groupId

string

default:"BqTwX8QFwXzpegMve9EQ"

Group Id

showDrafted

boolean

default:"False"

Show drafted

Respuestas

200 - Successful response

calendars

object[]

Show cada item

isActive

boolean

Should the created calendar be active or draft

notifications

object[]

🚨 Deprecated! Please use ‘Calendar Notifications APIs’ instead.

Show cada item

type

string

default:"email"

Calendar Notification Posibles valores: ‘email’

shouldSendToContact

boolean

required

shouldSendToGuest

boolean

required

shouldSendToUser

boolean

required

shouldSendToSelectedUsers

boolean

required

selectedUsers

string

default:"user1@testemail.com,user2@testemail.com"

required

Comma separated emails

locationId

string

default:"ocQHyuzHvysMo5N5VsXc"

required

groupId

string

default:"BqTwX8QFwXzpegMve9EQ"

Group Id

teamMembers

object[]

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

Show cada item

userId

string

default:"ocQHyuzHvysMo5N5VsXc"

required

priority

number

Posibles valores: 0, 0.5, 1

meetingLocationType

string

default:"custom"

🚨 Deprecated! Use locationConfigurations.kind instead. Posibles valores: ‘custom’, ‘zoom’, ‘gmeet’, ‘phone’, ‘address’, ‘teams’, ‘booker’

meetingLocation

string

🚨 Deprecated! Use locationConfigurations.account instead.

isPrimary

boolean

Marks a user as primary. This property is required in case of collective booking calendars. Only one user can be primary.

locationConfigurations

object[]

Meeting account configurations

Show cada item

kind

string

default:"custom"

required

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’

location

string

Address for meeting account. Not applicable on “zoom_conference”, “google_conference” and “ms_teams_conference” kind

meetingId

string

default:"my_conference_id"

Unique ID used to select a specific meeting account

eventType

string

Posibles valores: ‘RoundRobin_OptimizeForAvailability’, ‘RoundRobin_OptimizeForEqualDistribution’

name

string

default:"test calendar"

required

description

string

default:"this is used for testing"

slug

string

default:"test1"

calendarType

string

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’

eventTitle

string

eventColor

string

meetingLocation

string

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

locationConfigurations

object[]

Meeting account configuration for event calendar

Show cada item

kind

string

default:"custom"

required

location

string

Address for meeting account. Not applicable on “zoom_conference”, “google_conference” and “ms_teams_conference” kind

meetingId

string

default:"my_conference_id"

Unique ID used to select a specific meeting account

slotDuration

number

This controls the duration of the meeting

slotDurationUnit

string

Unit for slot duration. Posibles valores: ‘mins’, ‘hours’

slotInterval

number

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

slotIntervalUnit

string

Unit for slot interval. Posibles valores: ‘mins’, ‘hours’

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. Posibles valores: ‘mins’, ‘hours’

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. Posibles valores: ‘mins’, ‘hours’

appoinmentPerSlot

number

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

appoinmentPerDay

number

Number of appointments that can be booked for a given day

allowBookingAfter

number

Minimum scheduling notice for events

allowBookingAfterUnit

string

default:"days"

Unit for minimum scheduling notice Posibles valores: ‘hours’, ‘days’, ‘weeks’, ‘months’

allowBookingFor

number

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

allowBookingForUnit

string

default:"days"

Unit for controlling the duration for which booking would be allowed for Posibles valores: ‘days’, ‘weeks’, ‘months’

openHours

object[]

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

Show cada item

daysOfTheWeek

number[]

required

hours

object[]

required

Show cada item

openHour

number

required

openMinute

number

required

closeHour

number

required

closeMinute

number

required

enableRecurring

boolean

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

recurring

object

Show propiedades

freq

string

Posibles valores: ‘DAILY’, ‘WEEKLY’, ‘MONTHLY’

count

number

Number of recurrences

bookingOption

string

This setting contols what to do incase a recurring slot is unavailable Posibles valores: ‘skip’, ‘continue’, ‘book_next’

bookingOverlapDefaultStatus

string

This setting contols what to do incase a recurring slot is unavailable Posibles valores: ‘confirmed’, ‘new’

formId

string

stickyContact

boolean

isLivePaymentMode

boolean

autoConfirm

boolean

shouldSendAlertEmailsToAssignedMember

boolean

alertEmail

string

googleInvitationEmails

boolean

allowReschedule

boolean

allowCancellation

boolean

shouldAssignContactToTeamMember

boolean

shouldSkipAssigningContactForExisting

boolean

notes

string

pixelId

string

formSubmitType

string

Posibles valores: ‘RedirectURL’, ‘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. Posibles valores: 0, 1

availabilities

object[]

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

Show cada item

date

string

default:"2023-09-24T00:00:00.000Z"

required

Formulate the date string in the format of <YYYY-MM-DD in local timezone>T00:00:00.000Z.

hours

object[]

required

Show cada item

openHour

number

required

openMinute

number

required

closeHour

number

required

closeMinute

number

required

deleted

boolean

guestType

string

Posibles valores: ‘count_only’, ‘collect_detail’

calendarCoverImage

string

default:"https://path-to-image.com"

lookBusyConfig

object

Look Busy Configuration

string

default:"0TkCdp9PfvLeWKYRRvIz"

required

{
  "calendars": [
    {
      "isActive": true,
      "notifications": [
        {}
      ],
      "locationId": "ocQHyuzHvysMo5N5VsXc",
      "groupId": "BqTwX8QFwXzpegMve9EQ",
      "teamMembers": [
        {}
      ],
      "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": [
        {}
      ],
      "slotDuration": 30,
      "slotDurationUnit": "mins",
      "slotInterval": 30,
      "slotIntervalUnit": "mins",
      "slotBuffer": 0,
      "slotBufferUnit": "mins",
      "preBuffer": 0,
      "preBufferUnit": "mins",
      "appoinmentPerSlot": 1,
      "appoinmentPerDay": 0,
      "allowBookingAfter": 0,
      "allowBookingAfterUnit": "days",
      "allowBookingFor": 0,
      "allowBookingForUnit": "days",
  // truncado: 37 lineas mas
}

400 - Bad Request

{}

401 - Unauthorized

{}

Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/calendars/' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/calendars/', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/calendars/',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/calendars/');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);

​Autorización

​Query parameters

​Respuestas

​Ejemplo

Autorización

Query parameters

Respuestas

Ejemplo