HighLevel: Get Calendar

← Calendars operations · Get started

Operation gohighlevel.get_calendar

Provider route: GET /calendars/{calendarId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["calendars"]["getCalendar"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.calendars.getCalendar(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.calendars.get_calendar(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.calendarId	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Calendar — response body

Referenced models: Get Calendar — response body

Schemas

7 more schemas are linked from the tables above, on the schema pages.

Get Calendar — response body

Field	Type	Presence	Description and constraints
$	object	Root
calendar	Model	Required within parent	Expand Get Calendar — response body — calendar

Referenced models: Get Calendar — response body — calendar

Get Calendar — response body — calendar

Field	Type	Presence	Description and constraints
$	object	Root
alertEmail	string	Optional
allowBookingAfter	JSON	Optional
allowBookingAfter (anyOf 1)	number	Alternative	Minimum scheduling notice for events
allowBookingAfter (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
allowBookingAfterUnit	string	Optional	Unit for minimum scheduling notice Known values: hours, days, weeks, months, mins
allowBookingFor	JSON	Optional
allowBookingFor (anyOf 1)	number	Alternative	Minimum number of days/weeks/months for which to allow booking events
allowBookingFor (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
allowBookingForUnit	string	Optional	Unit for controlling the duration for which booking would be allowed for Known values: days, weeks, months
allowCancellation	boolean	Optional	Default: true
allowReschedule	boolean	Optional	Default: true
appoinmentPerDay	JSON	Optional
appoinmentPerDay (anyOf 1)	number	Alternative	Number of appointments that can be booked for a given day
appoinmentPerDay (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
appoinmentPerSlot	JSON	Optional
appoinmentPerSlot (anyOf 1)	number	Alternative	Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar. Default: 1
appoinmentPerSlot (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
autoConfirm	boolean	Optional	Default: true
availabilities	array	Optional	While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.
availabilities[]	Model	Each item	Expand Get Calendar — response body — calendar availabilities item
availabilityType	JSON	Optional
availabilityType (anyOf 1)	number	Alternative	While we will support this property for backward compatibility, it is not required anymore. Known values: 0, 1
availabilityType (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
calendarCoverImage	string	Optional
calendarType	string	Optional	Known values: round_robin, event, class_booking, collective, service_booking, personal
consentLabel	string	Optional
description	string	Optional
enableRecurring	boolean	Optional	Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this Default: false
eventColor	string	Optional	Default: #039be5
eventTitle	string	Optional	Default: {{contact.name}}
eventType	string	Optional	Known values: RoundRobin_OptimizeForAvailability, RoundRobin_OptimizeForEqualDistribution Default: RoundRobin_OptimizeForAvailability
formId	string	Optional
formSubmitRedirectURL	string	Optional
formSubmitThanksMessage	string	Optional
formSubmitType	string	Optional	Known values: RedirectURL, ThankYouMessage Default: ThankYouMessage
googleInvitationEmails	boolean	Optional	Default: false
groupId	string	Optional	Group Id
guestType	string	Optional	Known values: count_only, collect_detail
id	string	Required within parent
isActive	boolean	Optional	Should the created calendar be active or draft Default: true
isLivePaymentMode	boolean	Optional
locationConfigurations	array	Optional	Meeting location configuration for event calendar
locationConfigurations[]	Model	Each item	Expand Get Calendar — response body — calendar location Configurations item
locationId	string	Required within parent
lookBusyConfig	JSON	Optional	Look Busy Configuration
lookBusyConfig (allOf 1)	Model	All variants apply	Expand Get Calendar — response body — calendar look Busy Config Look Busy Percentage, enabled
meetingLocation	string	Optional	🚨 Deprecated! Use `locationConfigurations.location` or `teamMembers[].locationConfigurations.location` instead. Read only: true
name	string	Required within parent
notes	string	Optional
notifications	array	Optional	🚨 Deprecated! Please use 'Calendar Notifications APIs' instead.
notifications[]	Model	Each item	Expand Get Calendar — response body — calendar notifications item
openHours	array	Optional	While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.
openHours[]	Model	Each item	Expand Get Calendar — response body — calendar open Hours item
pixelId	string	Optional
preBuffer	JSON	Optional
preBuffer (anyOf 1)	number	Alternative	Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready
preBuffer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
preBufferUnit	string	Optional	Unit for pre-buffer. Known values: mins, hours
recurring	Model	Optional	Expand Get Calendar — response body — calendar recurring
shouldAssignContactToTeamMember	boolean	Optional
shouldSendAlertEmailsToAssignedMember	boolean	Optional
shouldSkipAssigningContactForExisting	boolean	Optional
slotBuffer	JSON	Optional
slotBuffer (anyOf 1)	number	Alternative	Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up
slotBuffer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
slotBufferUnit	string	Optional	Unit for slot buffer. Known values: mins, hours
slotDuration	JSON	Optional
slotDuration (anyOf 1)	number	Alternative	This controls the duration of the meeting Default: 30
slotDuration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
slotDurationUnit	string	Optional	Unit for slot duration. Known values: mins, hours
slotInterval	JSON	Optional
slotInterval (anyOf 1)	number	Alternative	Slot interval reflects the amount of time the between booking slots that will be shown in the calendar. Default: 30
slotInterval (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
slotIntervalUnit	string	Optional	Unit for slot interval. Known values: mins, hours
slug	string	Optional
stickyContact	boolean	Optional
teamMembers	array	Optional	Team members are for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.
teamMembers[]	Model	Each item	Expand Get Calendar — response body — calendar team Members item
widgetSlug	string	Optional
widgetType	string	Optional	Calendar widget type. Choose "default" for "neo" and "classic" for "classic" layout. Known values: default, classic Default: classic

Referenced models: Get Calendar — response body — calendar availabilities item, Get Calendar — response body — calendar notifications item, Get Calendar — response body — calendar location Configurations item, Get Calendar — response body — calendar look Busy Config Look Busy Percentage, enabled, Get Calendar — response body — calendar open Hours item, Get Calendar — response body — calendar recurring, Get Calendar — response body — calendar team Members item

Get Calendar — response body — calendar availabilities item

Field	Type	Presence	Description and constraints
$	object	Root
date	string	Required within parent	Formulate the date string in the format of `<YYYY-MM-DD in local timezone>T00:00:00.000Z`.
deleted	boolean	Optional	Default: false
hours	array	Required within parent
hours[]	Model	Each item	Expand Get Calendar — response body — calendar open Hours item hours item

Referenced models: Get Calendar — response body — calendar open Hours item hours item

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_calendar. Catalog operation: get-calendar. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["calendars.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source