--- title: "Retrieve booking info" method: GET path: "/scheduler/2027-03-beta/meetings/meeting-links/book/{slug}" tags: ["Basic"] --- # Retrieve booking info `GET /scheduler/2027-03-beta/meetings/meeting-links/book/{slug}` ## Request - Base URL: `https://api.hubapi.com` - URL: `https://api.hubapi.com/scheduler/2027-03-beta/meetings/meeting-links/book/{slug}` - Auth: OAuth 2 - Authorization code: `https://app.hubspot.com/oauth/authorize` - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `scheduler.meetings.meeting-link.read` Retrieve information about a specific meeting booking using a unique slug identifier. This endpoint provides details such as availability and busy times for the meeting link. It is useful for checking the status and details of a meeting link before booking. ## Path parameters - `slug` string, required ## Query parameters - `timezone` string, required ## Response `200` successful operation - ExternalBookingInfo - `allUsersBusyTimes` ExternalUserBusyTimes[], required: A list of busy times for all users associated with the meeting link, defined by the ExternalUserBusyTimes schema. - `busyTimes` ExternalTimeRange[], required: An array of time ranges during which the user is busy, represented by start and end timestamps. - `end` integer, required: The end of the time range, represented as an integer in int64 format. - `start` integer, required: The start of the time range, represented as an integer in int64 format. - `isOffline` boolean, required: A boolean indicating whether the user is offline. - `meetingsUser` ExternalMeetingsUser, required - `calendarProvider` 'EXCHANGE' | 'GOOGLE' | 'OFFICE365' | 'UNKNOWN', required: The calendar service provider used by the user. Valid values include 'GOOGLE', 'OFFICE365', 'EXCHANGE', and 'UNKNOWN'. - `id` string, required: The unique identifier for the external meetings user. - `isSalesStarter` boolean, required: A boolean indicating whether the user is a sales starter. - `userId` string, required: The unique identifier for the user within the system. - `userProfile` ExternalUserProfile, required - `email` string, required: The email address of the user. It is a required string property. - `firstName` string: The first name of the user. It is a string. - `fullName` string: The full name of the user, combining first and last names. It is a string. - `lastName` string: The last name of the user. It is a string. - `brandingMetadata` ExternalBrandingMetadata - `accent2Color` string: An additional accent color used in the branding, represented as a string. - `accentColor` string: The accent color used in the branding, represented as a string. - `companyAddressLine1` string: The first line of the company's address. - `companyAddressLine2` string: The second line of the company's address, if needed. - `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, typically used in URLs. - `companyName` string: The name of the company. - `companyState` string: The state where the company is located. - `companyZip` string: The postal code for the company's location. - `logoAltText` string, required: The alternative text for the logo, used for accessibility and when the image cannot be displayed. - `logoHeight` integer: The height of the logo in pixels. - `logoUrl` string: The URL of the logo image. - `logoWidth` integer: The width of the logo in pixels. - `primaryColor` string: The primary color used in the branding, represented as a string. - `secondaryColor` string: The secondary color used in the branding, represented as a string. - `showMarketingAd` boolean, required: Indicates whether a marketing advertisement should be displayed. This is a boolean value. - `showSalesAd` boolean, required: Indicates whether a sales advertisement should be displayed. This is a boolean value. - `customParams` ExternalMeetingsLinkSettings, required - `availability` object, required: An object representing the availability settings, with additional properties defined by the ExternalClosedRange schema. - `customAvailabilityEndDate` integer: An integer representing the custom end date for availability, in Unix time format. - `customAvailabilityStartDate` integer: An integer representing the custom start date for availability, in Unix time format. - `displayInfo` ExternalLinkDisplayInfo - `avatar` string: A string representing the URL or identifier for the avatar image to be displayed. - `companyAvatar` string: A string representing the URL or identifier for the company's avatar image. - `headline` string: A string representing the headline or title associated with the external link. - `publicDisplayAvatarOption` 'COMPANY_LOGO' | 'CUSTOM_AVATAR' | 'PROFILE_IMAGE': A string indicating the option for displaying the avatar. Valid values include 'PROFILE_IMAGE', 'COMPANY_LOGO', and 'CUSTOM_AVATAR'. - `durations` integer[], required: An array of integers representing the possible durations for meetings, in milliseconds. - `formFields` ExternalLinkFormField[], required: An array of form fields to be included with the meeting link, each defined by the ExternalLinkFormField schema. - `fieldType` string, required: A string indicating the type of the form field. - `isCustom` boolean, required: A boolean indicating whether the form field is custom. - `isRequired` boolean, required: A boolean indicating whether the form field is required. - `label` string, required: A string representing the label of the form field, which is displayed to users. - `name` string, required: A string representing the name of the form field. - `options` ExternalOption[], required: An array of ExternalOption objects representing the available options for the form field, if applicable. - `description` string, required: A string providing additional information about the option. - `displayOrder` integer, required: An integer that determines the order in which the option appears relative to other options. - `doubleData` number, required: A numeric value associated with the option, represented as a number. - `hidden` boolean, required: A boolean indicating whether the option should be hidden from the user interface. - `label` string, required: The display name of the option, shown to users. It is a string. - `readOnly` boolean, required: A boolean indicating whether the option is read-only and cannot be modified. - `value` string, required: The internal value associated with the option, used for processing. It is a string. - `type` string, required: A string specifying the type of data the form field holds. - `guestSettings` ExternalGuestSettings - `canAddGuests` boolean, required: A boolean indicating whether guests can be added to the meeting. - `maxGuestCount` integer, required: An integer specifying the maximum number of guests that can be invited to the meeting. - `language` string: A string representing the language setting for the meeting link. - `legalConsentEnabled` boolean, required: A boolean indicating whether legal consent is required for the meeting link. - `legalConsentOptions` ExternalLegalConsentOptions - `communicationConsentCheckboxes` ExternalCommunicationConsentCheckbox[], required: An array of communication consent checkboxes, each defined by an ExternalCommunicationConsentCheckbox object. - `communicationTypeId` string, required: A string representing the unique identifier for the type of communication consent. - `label` string, required: A string that provides the label text displayed next to the consent checkbox. - `required` boolean, required: A boolean indicating whether the consent checkbox is mandatory for the user to check. - `communicationConsentText` string, required: A string containing the text for communication consent. - `isLegitimateInterest` boolean, required: A boolean indicating whether the consent is based on legitimate interest. - `legitimateInterestLegalBasis` 'CONSENT_WITH_NOTICE' | 'LEGITIMATE_INTEREST_CLIENT' | 'LEGITIMATE_INTEREST_OTHER' | 'LEGITIMATE_INTEREST_PQL' | 'NON_GDPR' | 'PERFORMANCE_OF_CONTRACT' | 'PROCESS_AND_STORE': A string representing 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'. - `legitimateInterestSubscriptionTypes` integer[], required: An array of integers representing the subscription types that fall under legitimate interest. - `privacyPolicyText` string, required: A string containing the text of the privacy policy. - `processingConsentCheckboxLabel` string, required: A string representing the label for the processing consent checkbox. - `processingConsentFooterText` string, required: A string containing the footer text related to processing consent. - `processingConsentText` string, required: A string containing the text for processing consent. - `processingConsentType` 'IMPLICIT' | 'REQUIRED_CHECKBOX', required: A string indicating the type of processing consent required. Valid values are 'IMPLICIT' and 'REQUIRED_CHECKBOX'. - `locale` string: A string representing the locale setting for the meeting link. - `location` string: A string representing the location for the meeting. - `meetingBufferTime` integer, required: An integer representing the buffer time between meetings, in milliseconds. - `ownerPrioritized` boolean, required: A boolean indicating if the meeting owner's availability is prioritized. - `redirectUrl` string: A string representing 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: A string indicating the increment for start times. Valid values include 'MEETING_DURATION', 'FIVE', 'TEN', 'FIFTEEN', 'TWENTY', 'THIRTY', 'FORTY_FIVE', 'SIXTY', 'NINETY', 'ONE_HUNDRED_TWENTY'. - `weeksToAdvertise` integer, required: An integer indicating the number of weeks to advertise the meeting link. - `welcomeScreenInfo` ExternalMeetingsWelcomeScreenInfo - `description` string: The description text shown on the welcome screen. It is a string value. - `logoUrl` string: The URL of the logo image to be displayed on the welcome screen. It is a string value. - `showWelcomeScreen` boolean: A boolean value that determines whether the welcome screen should be shown. - `title` string: The title displayed on the welcome screen. It is a string value. - `useCompanyLogo` boolean: A boolean value indicating whether the company's logo should be used on the welcome screen. - `isOffline` boolean, required: Indicates whether the meeting link is offline. A boolean value. - `linkAvailability` ExternalLinkAvailability - `hasMore` boolean, required: A boolean indicating whether there are additional meeting slots available beyond the current set. - `linkAvailabilityByDuration` object, required: An object mapping meeting durations to their respective availability details. Each key is a duration, and the value is an object containing availability information for that duration. - `linkId` string, required: The unique identifier for the meeting link. - `linkType` 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR', required: The type of meeting link. Valid values include 'PERSONAL_LINK', 'GROUP_CALENDAR', and 'ROUND_ROBIN_CALENDAR'. ## Other responses - `default`: An error occurred. --- [API](https://skmtc.dev/hubspot/apis/scheduler-meetings.md) - [All operations](https://skmtc.dev/hubspot/apis/scheduler-meetings/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/scheduler-meetings/revisions/6d3443ad681b?raw)