HighLevel: List user availability schedule

← Calendars operations · Get started

Operation gohighlevel.getallschedules

Provider route: GET /calendars/schedules/search. 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"]["getAllSchedules"]>[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.getAllSchedules(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_all_schedules(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	Required within parent
query.calendarId	string	Optional
query.skip	number	Optional	Default: 0 Minimum: 0
query.limit	number	Optional	Default: 50 Maximum: 500 Minimum: 1

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 List user availability schedule — response body

Referenced models: List user availability schedule — response body

Schemas

List user availability schedule — response body

Field	Type	Presence	Description and constraints
$	object	Root
schedules	array	Required within parent	Array of schedules
schedules[]	Model	Each item	Expand List user availability schedule — response body — schedules item

Referenced models: List user availability schedule — response body — schedules item

List user availability schedule — response body — schedules item

Field	Type	Presence	Description and constraints
$	object	Root
calendarIds	array	Optional	Calendar IDs associated with the schedule
calendarIds[]	string	Each item
dateAdded	string	Required within parent	ISO date string when the schedule was created
dateUpdated	string	Required within parent	ISO date string when the schedule was last updated
deleted	boolean	Required within parent	Whether the schedule has been deleted
id	string	Required within parent	Unique identifier for the schedule
locationId	string	Required within parent	Location ID where this schedule applies
name	string	Required within parent	Human-readable name for the schedule
rules	array	Required within parent	Schedule rules defining when the schedule is active
rules[]	Model	Each item	Expand List user availability schedule — response body — schedules item rules item
timezone	string	Required within parent	Timezone for the schedule (IANA timezone identifier)
userId	string	Required within parent	User ID associated with the schedule

Referenced models: List user availability schedule — response body — schedules item rules item

List user availability schedule — response body — schedules item rules item

Field	Type	Presence	Description and constraints
$	object	Root
date	string	Optional	Specific date in YYYY-MM-DD format (only for date-type rules) Pattern: ^\d{4}-\d{2}-\d{2}$
day	string	Optional	Day of week (only for weekday-type rules) Known values: sunday, monday, tuesday, wednesday, thursday, friday, saturday
intervals	array	Required within parent	Time intervals for the rule (e.g., 9 AM to 5 PM)
intervals[]	Model	Each item	Expand Create user availability schedule — request body — body rules item intervals item
type	string	Required within parent	Type of schedule rule - weekday (recurring) or date (specific date) Known values: wday, date

Referenced models: Create user availability schedule — request body — body rules item intervals item

Create user availability schedule — request body — body rules item intervals item

Field	Type	Presence	Description and constraints
$	object	Root
from	string	Required within parent	Start time in HH:MM format (24-hour format) Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$
to	string	Required within parent	End time in HH:MM format (24-hour format) Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]$

Policy, approvals and errors

SDK function policy ID: gohighlevel.getallschedules. Catalog operation: getAllSchedules. 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