> ## 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: 57920374-fb0c-46cd-8d95-93a638f59823
---
# Retrieve meeting availability
> Retrieve the availability and busy times for a specific meeting link. This endpoint is useful for checking available slots for booking meetings based on the provided slug. It requires specifying the timezone and optionally allows adjusting the month view with an offset.
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/availability-page/{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/availability-page/{slug}:
get:
tags:
- Basic
summary: Retrieve availability
description: >-
Retrieve the availability and busy times for a specific meeting link.
This endpoint is useful for checking available slots for booking
meetings based on the provided slug. It requires specifying the timezone
and optionally allows adjusting the month view with an offset.
operationId: >-
get-/scheduler/2026-03/meetings/meeting-links/book/availability-page/{slug}
parameters:
- name: slug
in: path
description: >-
The unique identifier for the meeting link whose availability is
being retrieved.
required: true
style: simple
explode: false
schema:
type: string
- name: timezone
in: query
description: >-
The timezone in which the availability should be checked. This
parameter is required.
required: true
style: form
explode: true
schema:
type: string
- name: monthOffset
in: query
description: >-
An optional integer to adjust the month view. It allows you to view
availability for future or past months.
required: false
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalLinkAvailabilityAndBusyTimes'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- scheduler.meetings.meeting-link.read
components:
schemas:
ExternalLinkAvailabilityAndBusyTimes:
required:
- allUsersBusyTimes
type: object
properties:
allUsersBusyTimes:
type: array
description: >-
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.
items:
$ref: '#/components/schemas/ExternalUserBusyTimes'
linkAvailability:
$ref: '#/components/schemas/ExternalLinkAvailability'
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'
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'
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.
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}
)}