> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
---
id: 3a99b19b-cee2-404c-9cd3-b2fd2cbc2086
---
# Retrieve meeting link slug
> Retrieve detailed booking information for a specific meeting link using its slug. This endpoint provides insights into the availability and settings associated with the meeting link. It is useful for understanding the booking context and ensuring that the correct timezone is applied.
export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/2026-03/scheduler-meetings-v2026-03.json GET /scheduler/2026-03/meetings/meeting-links/book/{slug}
openapi: 3.0.1
info:
title: Scheduler Meetings
description: Meetings Service For HubSpot Sales
version: 2026-03
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Advanced
- name: Basic
paths:
/scheduler/2026-03/meetings/meeting-links/book/{slug}:
get:
tags:
- Basic
summary: Retrieve booking info
description: >-
Retrieve detailed booking information for a specific meeting link using
its slug. This endpoint provides insights into the availability and
settings associated with the meeting link. It is useful for
understanding the booking context and ensuring that the correct timezone
is applied.
operationId: get-/scheduler/2026-03/meetings/meeting-links/book/{slug}
parameters:
- name: slug
in: path
description: >-
The unique identifier for the meeting link to retrieve booking
information for.
required: true
style: simple
explode: false
schema:
type: string
- name: timezone
in: query
description: >-
The timezone to be used for the meeting link. This is required to
ensure the correct scheduling context.
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalBookingInfo'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- scheduler.meetings.meeting-link.read
components:
schemas:
ExternalBookingInfo:
required:
- allUsersBusyTimes
- customParams
- isOffline
- linkId
- linkType
type: object
properties:
allUsersBusyTimes:
type: array
description: >-
An array of objects representing the busy times for all users
associated with the meeting link.
items:
$ref: '#/components/schemas/ExternalUserBusyTimes'
brandingMetadata:
$ref: '#/components/schemas/ExternalBrandingMetadata'
customParams:
$ref: '#/components/schemas/ExternalMeetingsLinkSettings'
isOffline:
type: boolean
description: A boolean indicating whether the meeting link is offline.
linkAvailability:
$ref: '#/components/schemas/ExternalLinkAvailability'
linkId:
type: string
description: The unique identifier for the meeting link.
linkType:
type: string
description: >-
The type of meeting link. Valid values include 'PERSONAL_LINK',
'GROUP_CALENDAR', and 'ROUND_ROBIN_CALENDAR'.
enum:
- GROUP_CALENDAR
- PERSONAL_LINK
- ROUND_ROBIN_CALENDAR
ExternalUserBusyTimes:
required:
- busyTimes
- isOffline
- meetingsUser
type: object
properties:
busyTimes:
type: array
description: >-
An array of time ranges during which the user is busy. Each time
range is represented by an object with start and end times.
items:
$ref: '#/components/schemas/ExternalTimeRange'
isOffline:
type: boolean
description: A boolean indicating whether the user is currently offline.
meetingsUser:
$ref: '#/components/schemas/ExternalMeetingsUser'
ExternalBrandingMetadata:
required:
- logoAltText
- showMarketingAd
- showSalesAd
type: object
properties:
accent2Color:
type: string
description: The second accent color used for branding, represented as a string.
accentColor:
type: string
description: The accent color used for branding, represented as a string.
companyAddressLine1:
type: string
description: The first line of the company's address.
companyAddressLine2:
type: string
description: The second line of the company's address, if applicable.
companyAvatar:
type: string
description: The URL of the company's avatar image.
companyCity:
type: string
description: The city where the company is located.
companyCountry:
type: string
description: The country where the company is located.
companyDomain:
type: string
description: The domain of the company, typically used in URLs.
companyName:
type: string
description: The name of the company.
companyState:
type: string
description: The state or region where the company is located.
companyZip:
type: string
description: The postal or ZIP code of the company's location.
logoAltText:
type: string
description: The alternative text for the company logo, used for accessibility.
logoHeight:
type: integer
description: The height of the company logo in pixels.
format: int32
logoUrl:
type: string
description: The URL of the company logo image.
logoWidth:
type: integer
description: The width of the company logo in pixels.
format: int32
primaryColor:
type: string
description: The primary color used for branding, represented as a string.
secondaryColor:
type: string
description: The secondary color used for branding, represented as a string.
showMarketingAd:
type: boolean
description: >-
Indicates whether a marketing advertisement should be displayed.
This is a boolean value.
showSalesAd:
type: boolean
description: >-
Indicates whether a sales advertisement should be displayed. This is
a boolean value.
ExternalMeetingsLinkSettings:
required:
- availability
- durations
- formFields
- legalConsentEnabled
- meetingBufferTime
- ownerPrioritized
- startTimeIncrementMinutes
- weeksToAdvertise
type: object
properties:
availability:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalClosedRange'
description: >-
An object representing the availability settings for the meeting
link, with additional properties for closed ranges.
customAvailabilityEndDate:
type: integer
description: >-
An integer representing the custom availability end date as a Unix
timestamp in milliseconds.
format: int64
customAvailabilityStartDate:
type: integer
description: >-
An integer representing the custom availability start date as a Unix
timestamp in milliseconds.
format: int64
displayInfo:
$ref: '#/components/schemas/ExternalLinkDisplayInfo'
durations:
type: array
description: >-
An array of integers representing the possible durations for
meetings in milliseconds.
items:
type: integer
format: int64
formFields:
type: array
description: An array of form fields that are included in the meeting link form.
items:
$ref: '#/components/schemas/ExternalLinkFormField'
guestSettings:
$ref: '#/components/schemas/ExternalGuestSettings'
language:
type: string
description: A string representing the language setting for the meeting link.
legalConsentEnabled:
type: boolean
description: >-
A boolean indicating whether legal consent is required for the
meeting link.
legalConsentOptions:
$ref: '#/components/schemas/ExternalLegalConsentOptions'
locale:
type: string
description: A string representing the locale setting for the meeting link.
location:
type: string
description: A string representing the location information for the meeting.
meetingBufferTime:
type: integer
description: >-
An integer representing the buffer time between meetings in
milliseconds.
format: int64
ownerPrioritized:
type: boolean
description: >-
A boolean indicating whether the meeting owner is prioritized in
scheduling.
redirectUrl:
type: string
description: >-
A string representing the URL to which users are redirected after
booking a meeting.
startTimeIncrementMinutes:
type: string
description: >-
A string indicating the increment for start times, with valid values
including 'MEETING_DURATION', 'FIVE', 'TEN', 'FIFTEEN', 'TWENTY',
'THIRTY', 'FORTY_FIVE', 'SIXTY', 'NINETY', and 'ONE_HUNDRED_TWENTY'.
enum:
- FIFTEEN
- FIVE
- FORTY_FIVE
- MEETING_DURATION
- NINETY
- ONE_HUNDRED_TWENTY
- SIXTY
- TEN
- THIRTY
- TWENTY
weeksToAdvertise:
type: integer
description: >-
An integer representing the number of weeks to advertise the meeting
link.
format: int32
welcomeScreenInfo:
$ref: '#/components/schemas/ExternalMeetingsWelcomeScreenInfo'
ExternalLinkAvailability:
required:
- hasMore
- linkAvailabilityByDuration
type: object
properties:
hasMore:
type: boolean
description: >-
A boolean indicating whether there are more available meeting times
beyond those currently provided.
linkAvailabilityByDuration:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalLinkAvailabilityForDuration'
description: >-
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.
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category. It is a string.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition. It is an object where each
property is an array of strings.
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets. It is a string in UUID format.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: >-
Further information about the error. It is an array of ErrorDetail
objects.
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps. It is an object
where each property is a string.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate. It is a string.
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error. It is a string.
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
ExternalTimeRange:
required:
- end
- start
type: object
properties:
end:
type: integer
description: >-
The end of the time range, represented as an integer in int64
format.
format: int64
start:
type: integer
description: >-
The start of the time range, represented as an integer in int64
format.
format: int64
ExternalMeetingsUser:
required:
- calendarProvider
- id
- isSalesStarter
- userId
- userProfile
type: object
properties:
calendarProvider:
type: string
description: >-
The calendar service provider used by the user. Valid values include
'GOOGLE', 'OFFICE365', 'EXCHANGE', and 'UNKNOWN'.
enum:
- EXCHANGE
- GOOGLE
- OFFICE365
- UNKNOWN
id:
type: string
description: The unique identifier for the meetings user.
isSalesStarter:
type: boolean
description: A boolean indicating whether the user is a sales starter.
userId:
type: string
description: >-
The unique identifier for the user associated with the meetings
service.
userProfile:
$ref: '#/components/schemas/ExternalUserProfile'
ExternalClosedRange:
required:
- end
- start
type: object
properties:
end:
type: integer
description: >-
The ending point of the range, represented as an integer in int64
format.
format: int64
start:
type: integer
description: >-
The starting point of the range, represented as an integer in int64
format.
format: int64
ExternalLinkDisplayInfo:
type: object
properties:
avatar:
type: string
description: A string representing the URL of the avatar image to be displayed.
companyAvatar:
type: string
description: >-
A string representing the URL of the company avatar image to be
displayed.
headline:
type: string
description: >-
A string representing the headline text to be displayed with the
meeting link.
publicDisplayAvatarOption:
type: string
description: >-
A string indicating the avatar display option, with valid values
including 'PROFILE_IMAGE', 'COMPANY_LOGO', and 'CUSTOM_AVATAR'.
enum:
- COMPANY_LOGO
- CUSTOM_AVATAR
- PROFILE_IMAGE
ExternalLinkFormField:
required:
- fieldType
- isCustom
- isRequired
- label
- name
- options
- type
type: object
properties:
fieldType:
type: string
description: >-
The type of the form field, represented as a string, indicating the
kind of input expected.
isCustom:
type: boolean
description: >-
A boolean indicating whether the form field is a custom field
defined by the user.
isRequired:
type: boolean
description: >-
A boolean indicating whether the form field is mandatory for the
user to fill out.
label:
type: string
description: >-
The display label for the form field, shown to users, represented as
a string.
name:
type: string
description: >-
The unique name identifier for the form field, represented as a
string.
options:
type: array
description: >-
An array of options available for the form field, applicable if the
field type supports multiple choices.
items:
$ref: '#/components/schemas/ExternalOption'
type:
type: string
description: The specific data type of the form field, represented as a string.
ExternalGuestSettings:
required:
- canAddGuests
- maxGuestCount
type: object
properties:
canAddGuests:
type: boolean
description: A boolean indicating whether guests can be added to the meeting.
maxGuestCount:
type: integer
description: >-
An integer specifying the maximum number of guests that can be added
to the meeting.
format: int32
ExternalLegalConsentOptions:
required:
- communicationConsentCheckboxes
- communicationConsentText
- isLegitimateInterest
- legitimateInterestSubscriptionTypes
- privacyPolicyText
- processingConsentCheckboxLabel
- processingConsentFooterText
- processingConsentText
- processingConsentType
type: object
properties:
communicationConsentCheckboxes:
type: array
description: >-
An array of communication consent checkboxes, each defined by an
ExternalCommunicationConsentCheckbox object.
items:
$ref: '#/components/schemas/ExternalCommunicationConsentCheckbox'
communicationConsentText:
type: string
description: A string containing the text for communication consent.
isLegitimateInterest:
type: boolean
description: A boolean indicating whether legitimate interest is applicable.
legitimateInterestLegalBasis:
type: string
description: >-
A string indicating the legal basis for legitimate interest. Valid
values include 'LEGITIMATE_INTEREST_PQL',
'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT',
'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and
'LEGITIMATE_INTEREST_OTHER'.
enum:
- CONSENT_WITH_NOTICE
- LEGITIMATE_INTEREST_CLIENT
- LEGITIMATE_INTEREST_OTHER
- LEGITIMATE_INTEREST_PQL
- NON_GDPR
- PERFORMANCE_OF_CONTRACT
- PROCESS_AND_STORE
legitimateInterestSubscriptionTypes:
type: array
description: >-
An array of integers representing the subscription types that fall
under legitimate interest.
items:
type: integer
format: int64
privacyPolicyText:
type: string
description: A string containing the text for the privacy policy.
processingConsentCheckboxLabel:
type: string
description: A string representing the label for the processing consent checkbox.
processingConsentFooterText:
type: string
description: A string containing the footer text for processing consent.
processingConsentText:
type: string
description: A string containing the text for processing consent.
processingConsentType:
type: string
description: >-
A string indicating the type of processing consent. Valid values are
'IMPLICIT' and 'REQUIRED_CHECKBOX'.
enum:
- IMPLICIT
- REQUIRED_CHECKBOX
ExternalMeetingsWelcomeScreenInfo:
type: object
properties:
description:
type: string
description: >-
A descriptive text shown on the welcome screen. It is a string
value.
logoUrl:
type: string
description: >-
The URL of the logo image displayed on the welcome screen. It is a
string value.
showWelcomeScreen:
type: boolean
description: >-
A boolean indicating whether the welcome screen should be displayed
to users.
title:
type: string
description: The title displayed on the welcome screen. It is a string value.
useCompanyLogo:
type: boolean
description: >-
A boolean indicating whether the company's logo should be used on
the welcome screen.
ExternalLinkAvailabilityForDuration:
required:
- availabilities
- meetingDurationMillis
type: object
properties:
availabilities:
type: array
description: >-
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.
items:
$ref: '#/components/schemas/ExternalMeetingAvailability'
meetingDurationMillis:
type: integer
description: >-
The duration of the meeting in milliseconds. This is an integer
value representing the length of the meeting.
format: int64
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, represented as an object where
each property is an array of strings providing additional
information.
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate. This is a required field.
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error.
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
ExternalUserProfile:
required:
- email
type: object
properties:
email:
type: string
description: The email address of the user. This is a required string property.
firstName:
type: string
description: The first name of the user. It is a string.
fullName:
type: string
description: >-
The full name of the user, combining first and last names. It is a
string.
lastName:
type: string
description: The last name of the user. It is a string.
ExternalOption:
required:
- description
- displayOrder
- doubleData
- hidden
- label
- readOnly
- value
type: object
properties:
description:
type: string
description: A string providing a detailed description of the option.
displayOrder:
type: integer
description: >-
An integer indicating the order in which the option should be
displayed relative to other options.
format: int32
doubleData:
type: number
description: A number that may hold additional data associated with the option.
hidden:
type: boolean
description: A boolean indicating whether the option is hidden from display.
label:
type: string
description: A string representing the display name of the option.
readOnly:
type: boolean
description: >-
A boolean indicating whether the option is read-only and cannot be
modified.
value:
type: string
description: A string representing the internal value associated with the option.
ExternalCommunicationConsentCheckbox:
required:
- communicationTypeId
- label
- required
type: object
properties:
communicationTypeId:
type: string
description: >-
A string representing the unique identifier for the type of
communication this checkbox pertains to.
label:
type: string
description: >-
A string that contains the text label displayed next to the
checkbox, describing the communication type or purpose.
required:
type: boolean
description: >-
A boolean indicating whether this checkbox must be checked by the
user to proceed, signifying mandatory consent.
ExternalMeetingAvailability:
required:
- endMillisUtc
- startMillisUtc
type: object
properties:
endMillisUtc:
type: integer
description: >-
The end time of the meeting availability, represented as a Unix
timestamp in milliseconds.
format: int64
startMillisUtc:
type: integer
description: >-
The start time of the meeting availability, represented as a Unix
timestamp in milliseconds.
format: int64
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
crm.objects.contacts.sensitive.write.v2: ''
crm.schemas.meetings.write: ''
scheduler.meetings.meeting-link.read: ''
````
{product.name} -
{product.level}
)}