HighLevel: Get Service Bookings

← Calendars operations · Get started

Operation gohighlevel.get_service_bookings

Provider route: GET /calendars/services/bookings. 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"]["getServiceBookings"]>[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.getServiceBookings(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_service_bookings(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.startTime	string	Required within parent
query.endTime	string	Required within parent
query.timezone	string	Optional
query.serviceLocationId	string	Optional

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 Service Bookings — response body

Referenced models: Get Service Bookings — response body

Schemas

Get Service Bookings — response body

Field	Type	Presence	Description and constraints
$	object	Root
bookings	array	Required within parent	Service Bookings
bookings[]	Model	Each item	Expand Get Service Booking by ID — response body

Referenced models: Get Service Booking by ID — response body

Get Service Booking by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
bookingId	string	Required within parent	Booking ID
contactId	string	Required within parent	Contact ID
createdBy	JSON	Required within parent	Booking booked by metadata
createdBy (allOf 1)	Model	All variants apply	Expand Create Service Booking — response body — created By source, user Id
dateAdded	string	Required within parent	Date Added
dateUpdated	string	Required within parent	Date Updated
deleted	boolean	Required within parent	Tells if the booking is deleted
endTime	string	Required within parent	End Time
locationId	string	Required within parent	Location ID
meetingLocation	string	Optional	Meeting Location (If service location is an ask the booker, then the meeting location is used for the booking)
serviceLocationId	string	Required within parent	Service Location ID
services	array	Required within parent	Services
services[]	Model	Each item	Expand Create Service Booking — response body — services item
startTime	string	Required within parent	Start Time
status	string	Required within parent	Status
timezone	string	Required within parent	Timezone
title	string	Required within parent	Service Booking Title

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

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

Create Service Booking — response body — services item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Service ID
serviceAddOns	array	Optional	Service Add-ons
serviceAddOns[]	Model	Each item	Expand Create Service Booking — response body — services item service Add Ons item
serviceCategoryId	string	Required within parent	Service Category ID
serviceEndTime	string	Required within parent	Service End Time
serviceResources	array	Optional	Service Resources
serviceResources[]	Model	Each item	Expand Create Service Booking — response body — services item service Resources item
serviceStaffId	string	Required within parent	Service Staff ID
serviceStartTime	string	Required within parent	Service Start Time

Referenced models: Create Service Booking — response body — services item service Add Ons item, Create Service Booking — response body — services item service Resources item

Create Service Booking — response body — services item service Add Ons item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Add-on ID
quantity	JSON	Optional
quantity (anyOf 1)	number	Alternative	Add-on quantity
quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create Service Booking — response body — services item service Resources item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Resource ID

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_service_bookings. Catalog operation: get-service-bookings. 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