SchedulerMeetingLinkAllUserBusyTimesBySlug |
List booking informationGet details about the initial information necessary for a meeting scheduler.
Catalog: Meetings
Schema: Basic
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function SchedulerMeetingLinkAllUserBusyTimesBySlug. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
slug |
|
☑ |
|
|
timezone |
|
☑ |
|
|
Columns of Table Function
The columns of the table function SchedulerMeetingLinkAllUserBusyTimesBySlug are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
brandingMetadata_accent2Color |
varchar2 |
|
☐ |
The secondary accent color used in branding. |
brandingMetadata_accentColor |
varchar2 |
|
☐ |
The primary accent color used in branding. |
brandingMetadata_companyAddressLine1 |
varchar2 |
|
☐ |
The first line of the company's address. |
brandingMetadata_companyAddressLine2 |
varchar2 |
|
☐ |
The second line of the company's address. |
brandingMetadata_companyAvatar |
varchar2 |
|
☐ |
The URL of the company's avatar image. |
brandingMetadata_companyCity |
varchar2 |
|
☐ |
The city where the company is located. |
brandingMetadata_companyCountry |
varchar2 |
|
☐ |
The country where the company is located. |
brandingMetadata_companyDomain |
varchar2 |
|
☐ |
The domain of the company's website. |
brandingMetadata_companyName |
varchar2 |
|
☐ |
The name of the company. |
brandingMetadata_companyState |
varchar2 |
|
☐ |
The state where the company is located. |
brandingMetadata_companyZip |
varchar2 |
|
☐ |
The ZIP code of the company's location. |
brandingMetadata_logoAltText |
varchar2 |
|
☐ |
The alternative text for the current logo. |
brandingMetadata_logoHeight |
int32 |
|
☐ |
The height of the logo in pixels. |
brandingMetadata_logoUrl |
varchar2 |
|
☐ |
The URL of a custom logo image. |
brandingMetadata_logoWidth |
int32 |
|
☐ |
The width of the logo in pixels. |
brandingMetadata_primaryColor |
varchar2 |
|
☐ |
The primary color used in branding. |
brandingMetadata_secondaryColor |
varchar2 |
|
☐ |
The secondary color used in branding. |
brandingMetadata_showMarketingAd |
char |
|
☐ |
Whether Hubspot Marketing ads are shown. |
brandingMetadata_showSalesAd |
char |
|
☐ |
Whether Hubspot Sales ads are shown. |
customParams_availability |
varchar2 |
|
☐ |
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). |
customParams_customAvailabilityEndDate |
int64 |
|
☐ |
The end date for a meeting link's custom availability window, represented as Unix time in milliseconds. |
customParams_customAvailabilityStartDate |
int64 |
|
☐ |
The start date for a meeting link's custom availability window, represented as Unix time in milliseconds. |
customParams_displayInfo_avatar |
varchar2 |
|
☐ |
The URL of the user's custom uploaded avatar image. |
customParams_displayInfo_companyAvatar |
varchar2 |
|
☐ |
The URL of the company's avatar image. |
customParams_displayInfo_headline |
varchar2 |
|
☐ |
Deprecated field with no impact of link display info. |
customParams_displayInfo_publicDisplayAvatarOption |
varchar2 |
|
☐ |
Option for determining which avatar to display on scheduling page. Accepted values are: PROFILE_IMAGE, COMPANY_LOGO, CUSTOM_AVATAR, |
customParams_durations |
varchar2 |
|
☐ |
|
customParams_guestSettings_canAddGuests |
char |
|
☐ |
Indicates whether guests can be added to the meeting. |
customParams_guestSettings_maxGuestCount |
int32 |
|
☐ |
The maximum number of guests that can be added to the meeting. |
customParams_language |
varchar2 |
|
☐ |
The language setting used for the meeting link. |
customParams_legalConsentEnabled |
char |
|
☐ |
Whether the legal consent checkbox is displayed during meeting booking. |
customParams_legalConsentOptions_communicationConsentText |
varchar2 |
|
☐ |
The text that describes the consent for communication preferences. |
customParams_legalConsentOptions_isLegitimateInterest |
char |
|
☐ |
Whether the legal basis for processing is legitimate interest. |
customParams_legalConsentOptions_legitimateInterestLegalBasis |
varchar2 |
|
☐ |
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. |
customParams_legalConsentOptions_legitimateInterestSubscriptionTypes |
varchar2 |
|
☐ |
|
customParams_legalConsentOptions_privacyPolicyText |
varchar2 |
|
☐ |
The text that describes the data processing privacy policy. |
customParams_legalConsentOptions_processingConsentCheckboxLabel |
varchar2 |
|
☐ |
The label for the checkbox used to obtain consent for data processing. |
customParams_legalConsentOptions_processingConsentFooterText |
varchar2 |
|
☐ |
The footer text accompanying the consent for data processing. This field is not used by the meeting platform and will always be empty. |
customParams_legalConsentOptions_processingConsentText |
varchar2 |
|
☐ |
The text that describes the consent for processing personal data. |
customParams_legalConsentOptions_processingConsentType |
varchar2 |
|
☐ |
The type of consent required for processing. Accepted values are: IMPLICIT, REQUIRED_CHECKBOX. |
customParams_locale |
varchar2 |
|
☐ |
The locale setting used for formatting dates and times in the meeting link. |
customParams_location |
varchar2 |
|
☐ |
The physical or virtual location where the meeting will take place. |
customParams_meetingBufferTime |
int64 |
|
☐ |
The minimum buffer time in milliseconds between consecutive meetings. |
customParams_ownerPrioritized |
char |
|
☐ |
Indicates whether the meeting owner is prioritized during booking. Only applies to link types of ROUND_ROBIN. |
customParams_redirectUrl |
varchar2 |
|
☐ |
The URL to redirect to after a meeting is booked. |
customParams_startTimeIncrementMinutes |
varchar2 |
|
☐ |
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. |
customParams_weeksToAdvertise |
int32 |
|
☐ |
Legacy property that indicates the number of weeks in advance that availability is advertised. May be outdated or superseded by other properties. |
customParams_welcomeScreenInfo_description |
varchar2 |
|
☐ |
A brief description displayed the welcome screen below the title. |
customParams_welcomeScreenInfo_logoUrl |
varchar2 |
|
☐ |
The URL of the logo image to be displayed on the welcome screen, only used if `useCompanyLogo` is false. |
customParams_welcomeScreenInfo_showWelcomeScreen |
char |
|
☐ |
Deprecated property. Value can be ignored but will always be false. |
customParams_welcomeScreenInfo_title |
varchar2 |
|
☐ |
The main heading displayed on the welcome screen. |
customParams_welcomeScreenInfo_useCompanyLogo |
char |
|
☐ |
Whether the company's logo should be displayed on the welcome screen. |
end |
int64 |
|
☐ |
The end time of the time range, represented as Unix time in milliseconds. |
isOffline_2 |
char |
|
☐ |
Whether the meeting was booked offline, meaning no associated calendar event was created. |
isOffline |
char |
|
☐ |
Whether the user is offline. |
linkAvailability_hasMore |
char |
|
☐ |
Whether there are more available meeting times beyond the returned set. |
linkAvailability_linkAvailabilityByDuration |
varchar2 |
|
☐ |
Available booking slots for the meeting, grouped by the duration. |
linkId |
varchar2 |
|
☐ |
The unique identifier for the meeting link. |
linkType |
varchar2 |
|
☐ |
The type of the meeting link. Accepted values are: GROUP_CALENDAR, PERSONAL_LINK, ROUND_ROBIN_CALENDAR. |
meetingsUser_calendarProvider |
varchar2 |
|
☐ |
The calendar provider associated with the user. Accepted values are: GOOGLE, OFFICE365, EXCHANGE, UNKNOWN. |
meetingsUser_id |
varchar2 |
|
☐ |
The ID for the meetings user. This value is different than the userId. |
meetingsUser_isSalesStarter |
char |
|
☐ |
Whether the user has a sales starter seat. |
meetingsUser_userId |
varchar2 |
|
☐ |
The ID of the user. |
meetingsUser_userProfile_email |
varchar2 |
|
☐ |
The email address of the user. |
meetingsUser_userProfile_firstName |
varchar2 |
|
☐ |
The first name of the user. |
meetingsUser_userProfile_fullName |
varchar2 |
|
☐ |
The full name of the user. |
meetingsUser_userProfile_lastName |
varchar2 |
|
☐ |
The last name of the user. |
start |
int64 |
|
☐ |
The start time of the time range, represented as Unix time in milliseconds. |
HubSpot API Data Model