--- title: "List booking information" method: GET path: "/scheduler/2026-03/meetings/meeting-links/book/{slug}" tags: ["Basic"] --- # List booking information `GET /scheduler/2026-03/meetings/meeting-links/book/{slug}` ## Request - Base URL: `https://api.hubapi.com` - URL: `https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links/book/{slug}` - Auth: one of: - HTTP bearer - API key in query parameter `hapikey` - none Get details about the initial information necessary for a meeting scheduler. ## Path parameters - `slug` string, required ## Query parameters - `timezone` string, required ## Response `200` successful operation - SchedulerMeetingsExternalBookingInfo - `allUsersBusyTimes` SchedulerMeetingsExternalUserBusyTimes[], required - `busyTimes` SchedulerMeetingsExternalTimeRange[], required - `end` integer, required: The end time of the time range, represented as Unix time in milliseconds. - `start` integer, required: The start time of the time range, represented as Unix time in milliseconds. - `isOffline` boolean, required: Whether the user is offline. - `meetingsUser` SchedulerMeetingsExternalMeetingsUser, required - `calendarProvider` 'EXCHANGE' | 'GOOGLE' | 'OFFICE365' | 'UNKNOWN', required: The calendar provider associated with the user. Accepted values are: GOOGLE, OFFICE365, EXCHANGE, UNKNOWN. - `id` string, required: The ID for the meetings user. This value is different than the userId. - `isSalesStarter` boolean, required: Whether the user has a sales starter seat. - `userId` string, required: The ID of the user. - `userProfile` SchedulerMeetingsExternalUserProfile, required - `email` string, required: The email address of the user. - `firstName` string: The first name of the user. - `fullName` string: The full name of the user. - `lastName` string: The last name of the user. - `brandingMetadata` SchedulerMeetingsExternalBrandingMetadata - `accent2Color` string: The secondary accent color used in branding. - `accentColor` string: The primary accent color used in branding. - `companyAddressLine1` string: The first line of the company's address. - `companyAddressLine2` string: The second line of the company's address. - `companyAvatar` string: The URL of the company's avatar image. - `companyCity` string: The city where the company is located. - `companyCountry` string: The country where the company is located. - `companyDomain` string: The domain of the company's website. - `companyName` string: The name of the company. - `companyState` string: The state where the company is located. - `companyZip` string: The ZIP code of the company's location. - `logoAltText` string, required: The alternative text for the current logo. - `logoHeight` integer: The height of the logo in pixels. - `logoUrl` string: The URL of a custom logo image. - `logoWidth` integer: The width of the logo in pixels. - `primaryColor` string: The primary color used in branding. - `secondaryColor` string: The secondary color used in branding. - `showMarketingAd` boolean, required: Whether Hubspot Marketing ads are shown. - `showSalesAd` boolean, required: Whether Hubspot Sales ads are shown. - `customParams` SchedulerMeetingsExternalMeetingsLinkSettings, required - `availability` object, required: An array containing the closed range availability for a meeting link. Closed range times are provided as minute offsets from midnight (e.g., 540 corresponds to 9am). - `customAvailabilityEndDate` integer: The end date for a meeting link's custom availability window, represented as Unix time in milliseconds. - `customAvailabilityStartDate` integer: The start date for a meeting link's custom availability window, represented as Unix time in milliseconds. - `displayInfo` SchedulerMeetingsExternalLinkDisplayInfo - `avatar` string: The URL of the user's custom uploaded avatar image. - `companyAvatar` string: The URL of the company's avatar image. - `headline` string: Deprecated field with no impact of link display info. - `publicDisplayAvatarOption` 'COMPANY_LOGO' | 'CUSTOM_AVATAR' | 'PROFILE_IMAGE': Option for determining which avatar to display on scheduling page. Accepted values are: PROFILE_IMAGE, COMPANY_LOGO, CUSTOM_AVATAR, - `durations` integer[], required - `formFields` SchedulerMeetingsExternalLinkFormField[], required - `fieldType` string, required: The specific field type of the form field. Corresponds to property types (e.g., `select`, `radio`, `date`, etc) - `isCustom` boolean, required: Whether the form field is a custom field. - `isRequired` boolean, required: Whether the form field is mandatory. - `label` string, required: The text label for the form field. - `name` string, required: The name identifier for the form field. - `options` SchedulerMeetingsExternalOption[], required - `description` string, required: A brief description of the option. - `displayOrder` integer, required: The order in which the option should be displayed. - `doubleData` number, required: Deprecated property. Will always be 0. - `hidden` boolean, required: Whether the option should be hidden from the user. - `label` string, required: The text label for the option. - `readOnly` boolean, required: Whether the option is read-only. - `value` string, required: The value associated with the option. - `type` string, required: The data type of the form field accepts (e.g. `date`, `enumeration`, etc) - `guestSettings` SchedulerMeetingsExternalGuestSettings - `canAddGuests` boolean, required: Indicates whether guests can be added to the meeting. - `maxGuestCount` integer, required: The maximum number of guests that can be added to the meeting. - `language` string: The language setting used for the meeting link. - `legalConsentEnabled` boolean, required: Whether the legal consent checkbox is displayed during meeting booking. - `legalConsentOptions` SchedulerMeetingsExternalLegalConsentOptions - `communicationConsentCheckboxes` SchedulerMeetingsExternalCommunicationConsentCheckbox[], required - `communicationTypeId` string, required: The ID of the communication consent form being recorded. - `label` string, required: The text label describing the consent being given. - `required` boolean, required: Whether the consent checkbox is required. - `communicationConsentText` string, required: The text that describes the consent for communication preferences. - `isLegitimateInterest` boolean, required: Whether the legal basis for processing is legitimate interest. - `legitimateInterestLegalBasis` 'CONSENT_WITH_NOTICE' | 'LEGITIMATE_INTEREST_CLIENT' | 'LEGITIMATE_INTEREST_OTHER' | 'LEGITIMATE_INTEREST_PQL' | 'NON_GDPR' | 'PERFORMANCE_OF_CONTRACT' | 'PROCESS_AND_STORE': The legal basis for processing under legitimate interest. Accepted values are: LEGITIMATE_INTEREST_PQL, LEGITIMATE_INTEREST_CLIENT, PERFORMANCE_OF_CONTRACT, CONSENT_WITH_NOTICE, NON_GDPR, PROCESS_AND_STORE, LEGITIMATE_INTEREST_OTHER. - `legitimateInterestSubscriptionTypes` integer[], required - `privacyPolicyText` string, required: The text that describes the data processing privacy policy. - `processingConsentCheckboxLabel` string, required: The label for the checkbox used to obtain consent for data processing. - `processingConsentFooterText` string, required: The footer text accompanying the consent for data processing. This field is not used by the meeting platform and will always be empty. - `processingConsentText` string, required: The text that describes the consent for processing personal data. - `processingConsentType` 'IMPLICIT' | 'REQUIRED_CHECKBOX', required: The type of consent required for processing. Accepted values are: IMPLICIT, REQUIRED_CHECKBOX. - `locale` string: The locale setting used for formatting dates and times in the meeting link. - `location` string: The physical or virtual location where the meeting will take place. - `meetingBufferTime` integer, required: The minimum buffer time in milliseconds between consecutive meetings. - `ownerPrioritized` boolean, required: Indicates whether the meeting owner is prioritized during booking. Only applies to link types of ROUND_ROBIN. - `redirectUrl` string: The URL to redirect to after a meeting is booked. - `startTimeIncrementMinutes` 'FIFTEEN' | 'FIVE' | 'FORTY_FIVE' | 'MEETING_DURATION' | 'NINETY' | 'ONE_HUNDRED_TWENTY' | 'SIXTY' | 'TEN' | 'THIRTY' | 'TWENTY', required: The increment for available start times of meetings, spelt out as a word (e.g. 15 minute increment corresponds to `FIFTEEN`). `MEETING_DURATION` is also a valid value. - `weeksToAdvertise` integer, required: Legacy property that indicates the number of weeks in advance that availability is advertised. May be outdated or superseded by other properties. - `welcomeScreenInfo` SchedulerMeetingsExternalMeetingsWelcomeScreenInfo - `description` string: A brief description displayed the welcome screen below the title. - `logoUrl` string: The URL of the logo image to be displayed on the welcome screen, only used if `useCompanyLogo` is false. - `showWelcomeScreen` boolean: Deprecated property. Value can be ignored but will always be false. - `title` string: The main heading displayed on the welcome screen. - `useCompanyLogo` boolean: Whether the company's logo should be displayed on the welcome screen. - `isOffline` boolean, required: Whether the meeting was booked offline, meaning no associated calendar event was created. - `linkAvailability` SchedulerMeetingsExternalLinkAvailability - `hasMore` boolean, required: Whether there are more available meeting times beyond the returned set. - `linkAvailabilityByDuration` object, required: Available booking slots for the meeting, grouped by the duration. - `linkId` string, required: The unique identifier for the meeting link. - `linkType` 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR', required: The type of the meeting link. Accepted values are: GROUP_CALENDAR, PERSONAL_LINK, ROUND_ROBIN_CALENDAR. ## Other responses - `default`: An error occurred. ## Changes > 14 revisions in range; 1 not diffed, 2 could not be searched. - **2026-03-25** `37a93e10d5c4`: 1 info - endpoint added [Operation history](https://skmtc.dev/hubspot/apis/hubspot-api-specification/changes/scheduler/2026-03/meetings/meeting-links/book/:slug/get.md) --- [API](https://skmtc.dev/hubspot/apis/hubspot-api-specification.md) - [All operations](https://skmtc.dev/hubspot/apis/hubspot-api-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/hubspot-api-specification/revisions/f9c7181056c5?raw)