HighLevel: Get Blocked Slots

← Calendars operations · Get started

Operation gohighlevel.get_blocked_slots

Provider route: GET /calendars/blocked-slots. 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"]["getBlockedSlots"]>[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.getBlockedSlots(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_blocked_slots(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent
query.userId	string	Optional
query.calendarId	string	Optional
query.groupId	string	Optional
query.startTime	string	Required within parent
query.endTime	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 Blocked Slots — response body

Referenced models: Get Blocked Slots — response body

Schemas

Get Blocked Slots — response body

Field	Type	Presence	Description and constraints
$	object	Root
events	array	Optional
events[]	Model	Each item	Expand Get Appointment — response body — event

Referenced models: Get Appointment — response body — event

Get Appointment — response body — event

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Calendar Event address
appointmentStatus	string	Required within parent	Appointment Status
assignedResources	array	Optional	Ids of associated resources rooms and/or equipments
assignedResources[]	string	Each item
assignedUserId	string	Required within parent	AssignedUser - the primary owner of an appointment
calendarId	string	Required within parent	Calendar ID
contactId	string	Required within parent	Contact ID
createdBy	JSON	Optional	Appointment booked by metadata
createdBy (allOf 1)	Model	All variants apply	Expand Create Service Booking — response body — created By source, user Id
dateAdded	object	Required within parent	Date Added
dateUpdated	object	Required within parent	Date Updated
deleted	boolean	Optional	Tells if a calendar event has been deleted
description	string	Optional	Description
endTime	object	Required within parent	End Time
groupId	string	Required within parent	Group ID
id	string	Required within parent	Event Id or Instance id for a recurring event
isRecurring	boolean	Optional	true if the event is recurring otherwise false
locationId	string	Required within parent	Location ID
masterEventId	string	Optional	Master event id for a recurring instance
notes	string	Optional	Notes
rrule	string	Optional	RRULE as per the iCalendar (RFC 5545) specification for recurring events. DTSTART is not required, instance ids are calculated on the basis of startTime of the event.
startTime	object	Required within parent	Start Time
title	string	Required within parent	Calendar Event title
users	array	Required within parent	Users - the secondary owners of an appointment.
users[]	string	Each item

Referenced models: Create Service Booking — response body — created By source, user Id

Create Service Booking — response body — created By source, user Id

Field	Type	Presence	Description and constraints
$	object	Root
source	string	Required within parent	The source of the appointment
userId	string	Optional	The ID of the user who created or updated the appointment

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_blocked_slots. Catalog operation: get-blocked-slots. 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/events.readonly"]

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

Official provider source