HubSpot: List Meeting Links

← Scheduler operations · Get started

Operation hubspot.scheduler_get_meeting_links

Provider route: GET /scheduler/2026-09/meetings/meeting-links. 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"]["getMeetingLinks"]>[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.getMeetingLinks(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.get_meeting_links(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.after	string	Optional
query.limit	integer	Optional	Format: int32
query.name	string	Optional
query.organizerUserId	string	Optional
query.type	string	Optional	One of: GROUP_CALENDAR, PERSONAL_LINK, ROUND_ROBIN_CALENDAR

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 Meeting Links — response body

Referenced models: List Meeting Links — response body

Schemas

List Meeting Links — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Meeting Links — response body — paging
results	array	Required within parent	An array of external link metadata objects. Each object contains details about an external meeting link.
results[]	Model	Each item	Expand List Meeting Links — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The total number of external link metadata entries available. This is an integer value. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Meeting Links — response body — results item, List Meeting Links — response body — paging

List Meeting Links — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when the meeting link was created, in ISO 8601 format. Format: date-time
defaultLink	boolean	Required within parent	A boolean indicating whether this is the default meeting link.
id	string	Required within parent	The unique identifier for the meeting link.
link	string	Required within parent	The full URL of the meeting link.
name	string	Optional	The name of the meeting link.
organizerUserId	string	Required within parent	The unique identifier of the user who organized the meeting.
paymentLinkId	string	Optional	An integer representing the identifier for the payment link associated with the meeting.
slug	string	Required within parent	A string representing the unique part of the URL for the meeting link.
type	string	Required within parent	The type of meeting link. Valid values include 'PERSONAL_LINK', 'GROUP_CALENDAR', and 'ROUND_ROBIN_CALENDAR'. Known values: GROUP_CALENDAR, PERSONAL_LINK, ROUND_ROBIN_CALENDAR
updatedAt	string	Optional	The date and time when the meeting link was last updated, in ISO 8601 format. Format: date-time
userIdsOfLinkMembers	array	Required within parent	An array of user IDs representing the members associated with the meeting link.
userIdsOfLinkMembers[]	string	Each item

List Meeting Links — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand List Meeting Links — response body — paging next
prev	Model	Optional	Expand List Meeting Links — response body — paging prev

Referenced models: List Meeting Links — response body — paging next, List Meeting Links — response body — paging prev

List Meeting Links — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string representing the paging cursor token for the next set of results.
link	string	Optional	A string containing the URL link to the next page of results.

List Meeting Links — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token used to retrieve the previous page of results.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Policy, approvals and errors

SDK function policy ID: hubspot.scheduler_get_meeting_links. Catalog operation: scheduler_get_meeting_links. 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