HighLevel: Get Service by ID

HighLevel calendars.getServiceCatalogById: arguments, response, policy and SDK examples.

Operation gohighlevel.get_service_catalog_by_id

Provider route: GET /calendars/services/catalog/{serviceId}. 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"]["getServiceCatalogById"]>[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.getServiceCatalogById(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_catalog_by_id(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.serviceId`	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 Create Service — response body

Referenced models: Create Service — response body

Schemas

Create Service — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`service`	JSON	Required within parent	Service details
`service (allOf 1)`	Model	All variants apply	Expand Get Services — response body — services item

Referenced models: Get Services — response body — services item

Get Services — response body — services item

Field	Type	Presence	Description and constraints
`$`	object	Root
`coverImage`	string	Optional	Service cover image URL
`description`	string	Optional	Service description
`eventColor`	string	Optional	Service event color (hex)
`formId`	string	Optional	Custom form ID (will be used to display the custom form on the booking page, if only one service is selected)
`id`	string	Required within parent	Service ID
`isPrivate`	boolean	Optional	Whether service is private (not shown publicly) Default: false
`locationId`	string	Required within parent	Location ID
`name`	string	Required within parent	Service name
`payment`	JSON	Optional	Payment details
`payment (allOf 1)`	Model	All variants apply	Expand Get Services — response body — services / item / payment / depositType: percentage, amount
`postBuffer`	JSON	Optional
`postBuffer (anyOf 1)`	number	Alternative	Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up
`postBuffer (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`postBufferUnit`	string	Optional	Post-buffer unit Known values: mins, hours
`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	Pre-buffer unit Known values: mins, hours
`serviceCategoryId`	string	Optional	Service category ID
`serviceDuration`	JSON	Optional
`serviceDuration (anyOf 1)`	number	Alternative	This controls the duration of the appointment
`serviceDuration (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`serviceDurationUnit`	string	Optional	Duration unit Known values: mins, hours
`slug`	string	Optional	Unique URL-friendly identifier
`staff`	array	Optional	Assigned staff members
`staff[]`	Model	Each item	Expand Create Service — request body — body staff item
`variations`	array	Optional	Service variations
`variations[]`	Model	Each item	Expand Get Services — response body — services item variations item

Referenced models: Get Services — response body — services / item / payment / depositType: percentage, amount, Get Services — response body — services item variations item, Create Service — request body — body staff item

Get Services — response body — services / item / payment / depositType: percentage, amount

Field	Type	Presence	Description and constraints
`$`	object	Root
`amount`	JSON	Optional
`amount (anyOf 1)`	number	Alternative	Service price
`amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`deposit`	JSON	Optional
`deposit (anyOf 1)`	number	Alternative	Deposit amount or percentage value
`deposit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`depositType`	string	Optional	Deposit type Known values: percentage, amount

Get Services — response body — services item variations item

Field	Type	Presence	Description and constraints
`$`	object	Root
`id`	string	Required within parent	Variation ID
`name`	string	Required within parent	Variation name
`payment`	JSON	Optional	Payment details
`payment (allOf 1)`	Model	All variants apply	Expand Get Services — response body — services / item / payment / depositType: percentage, amount
`postBuffer`	JSON	Optional
`postBuffer (anyOf 1)`	number	Alternative	Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up
`postBuffer (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`postBufferUnit`	string	Optional	Post-buffer unit Known values: mins, hours
`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	Pre-buffer unit Known values: mins, hours
`serviceDuration`	JSON	Optional
`serviceDuration (anyOf 1)`	number	Alternative	This controls the duration of the appointment
`serviceDuration (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`serviceDurationUnit`	string	Optional	Duration unit Known values: mins, hours

Referenced models: Get Services — response body — services / item / payment / depositType: percentage, amount

Create Service — request body — body staff item

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

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_service_catalog_by_id. Catalog operation: get-service-catalog-by-id. 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

Report an issue with this page