HubSpot: Retrieve availability

← Scheduler operations · Get started

Operation hubspot.scheduler_meetings_get_availability

Provider route: GET /scheduler/2026-09/meetings/meeting-links/book/availability-page/{slug}. Alter supplies the connection’s credentials and routing.

Call through Alter

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

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

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

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.scheduler.meetings_get_availability(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.slug	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.timezone	string	Required within parent
query.monthOffset	integer	Optional	Format: int32

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 Retrieve availability — response body

Referenced models: Retrieve availability — response body

Schemas

Retrieve availability — response body

Field	Type	Presence	Description and constraints
$	object	Root
allUsersBusyTimes	array	Required within parent	An array of objects representing the busy times for all users associated with the meeting link. Each object includes the user's busy time ranges.
allUsersBusyTimes[]	Model	Each item	Expand Retrieve availability — response body — all Users Busy Times item
linkAvailability	Model	Optional	Expand Retrieve availability — response body — link Availability

Referenced models: Retrieve availability — response body — link Availability, Retrieve availability — response body — all Users Busy Times item

Retrieve availability — response body — link Availability

Field	Type	Presence	Description and constraints
$	object	Root
hasMore	boolean	Required within parent	A boolean indicating whether there are more available meeting times beyond those currently provided.
linkAvailabilityByDuration	object	Required within parent	An object where each key is a duration and the value is an availability object for that duration. This provides detailed availability information for each specified meeting duration. Additional keys: see wildcard field
linkAvailabilityByDuration.*	Model	Additional keys	Expand Retrieve availability — response body — link Availability link Availability By Duration value

Referenced models: Retrieve availability — response body — link Availability link Availability By Duration value

Retrieve availability — response body — all Users Busy Times item

Field	Type	Presence	Description and constraints
$	object	Root
busyTimes	array	Required within parent	An array of time ranges during which the user is busy. Each time range is represented by an object with start and end times.
busyTimes[]	Model	Each item	Expand Retrieve availability — response body — all Users Busy Times item busy Times item
isOffline	boolean	Required within parent	A boolean indicating whether the user is currently offline.
meetingsUser	Model	Required within parent	Expand Retrieve availability — response body — all Users Busy Times item meetings User

Referenced models: Retrieve availability — response body — all Users Busy Times item meetings User, Retrieve availability — response body — all Users Busy Times item busy Times item

Retrieve availability — response body — link Availability link Availability By Duration value

Field	Type	Presence	Description and constraints
$	object	Root
availabilities	array	Required within parent	An array of available time slots for the specified meeting duration. Each item in the array is an object representing a time slot's start and end times.
availabilities[]	Model	Each item	Expand Retrieve availability — response body — link Availability link Availability By Duration value availabilities item
meetingDurationMillis	JSON	Required within parent
meetingDurationMillis (anyOf 1)	integer	Alternative	The duration of the meeting in milliseconds. This is an integer value representing the length of the meeting. Format: int64
meetingDurationMillis (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve availability — response body — link Availability link Availability By Duration value availabilities item

Retrieve availability — response body — all Users Busy Times item meetings User

Field	Type	Presence	Description and constraints
$	object	Root
calendarProvider	string	Required within parent	The calendar service provider used by the user. Valid values include 'GOOGLE', 'OFFICE365', 'EXCHANGE', and 'UNKNOWN'. Known values: EXCHANGE, GOOGLE, OFFICE365, UNKNOWN
id	string	Required within parent	The unique identifier for the meetings user.
isSalesStarter	boolean	Required within parent	A boolean indicating whether the user is a sales starter.
userId	string	Required within parent	The unique identifier for the user associated with the meetings service.
userProfile	Model	Required within parent	Expand Retrieve availability — response body — all Users Busy Times item meetings User user Profile

Referenced models: Retrieve availability — response body — all Users Busy Times item meetings User user Profile

Retrieve availability — response body — all Users Busy Times item busy Times item

Field	Type	Presence	Description and constraints
$	object	Root
end	JSON	Required within parent
end (anyOf 1)	integer	Alternative	The end of the time range, represented as an integer in int64 format. Format: int64
end (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start	JSON	Required within parent
start (anyOf 1)	integer	Alternative	The start of the time range, represented as an integer in int64 format. Format: int64
start (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve availability — response body — link Availability link Availability By Duration value availabilities item

Field	Type	Presence	Description and constraints
$	object	Root
endMillisUtc	JSON	Required within parent
endMillisUtc (anyOf 1)	integer	Alternative	The end time of the meeting availability, represented as a Unix timestamp in milliseconds. Format: int64
endMillisUtc (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startMillisUtc	JSON	Required within parent
startMillisUtc (anyOf 1)	integer	Alternative	The start time of the meeting availability, represented as a Unix timestamp in milliseconds. Format: int64
startMillisUtc (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve availability — response body — all Users Busy Times item meetings User user Profile

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email address of the user. This is a required string property.
firstName	string	Optional	The first name of the user. It is a string.
fullName	string	Optional	The full name of the user, combining first and last names. It is a string.
lastName	string	Optional	The last name of the user. It is a string.

Policy, approvals and errors

SDK function policy ID: hubspot.scheduler_meetings_get_availability. Catalog operation: scheduler_meetings_get_availability. 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: ["scheduler.meetings.meeting-link.read"]

Official provider source