curl --request GET \
--url https://api.hubapi.com/scheduler/v3/meetings/meeting-links/book/{slug} \
--header 'Authorization: Bearer <token>'
{
"linkId": "<string>",
"customParams": {
"redirectUrl": "<string>",
"startTimeIncrementMinutes": "<string>",
"guestSettings": {
"maxGuestCount": 123,
"canAddGuests": true
},
"language": "<string>",
"availability": {},
"locale": "<string>",
"ownerPrioritized": true,
"legalConsentOptions": {
"legitimateInterestSubscriptionTypes": [
123
],
"processingConsentCheckboxLabel": "<string>",
"communicationConsentText": "<string>",
"legitimateInterestLegalBasis": "LEGITIMATE_INTEREST_PQL",
"processingConsentType": "<string>",
"privacyPolicyText": "<string>",
"processingConsentText": "<string>",
"communicationConsentCheckboxes": [
{
"communicationTypeId": "<string>",
"label": "<string>",
"required": true
}
],
"processingConsentFooterText": "<string>",
"isLegitimateInterest": true
},
"welcomeScreenInfo": {
"useCompanyLogo": true,
"description": "<string>",
"showWelcomeScreen": true,
"title": "<string>",
"logoUrl": "<string>"
},
"meetingBufferTime": 123,
"weeksToAdvertise": 123,
"displayInfo": {
"publicDisplayAvatarOption": "<string>",
"companyAvatar": "<string>",
"avatar": "<string>",
"headline": "<string>"
},
"durations": [
123
],
"location": "<string>",
"formFields": [
{
"isRequired": true,
"name": "<string>",
"options": [
{
"hidden": true,
"displayOrder": 123,
"doubleData": 123,
"description": "<string>",
"readOnly": true,
"label": "<string>",
"value": "<string>"
}
],
"isCustom": true,
"label": "<string>",
"type": "<string>",
"fieldType": "<string>"
}
],
"legalConsentEnabled": true,
"customAvailabilityEndDate": 123,
"customAvailabilityStartDate": 123
},
"linkAvailability": {
"hasMore": true,
"linkAvailabilityByDuration": {}
},
"brandingMetadata": {
"logoHeight": 123,
"logoAltText": "<string>",
"companyCity": "<string>",
"companyAddressLine1": "<string>",
"showSalesAd": true,
"companyAddressLine2": "<string>",
"accentColor": "<string>",
"companyName": "<string>",
"companyState": "<string>",
"primaryColor": "<string>",
"showMarketingAd": true,
"accent2Color": "<string>",
"companyDomain": "<string>",
"logoUrl": "<string>",
"logoWidth": 123,
"companyCountry": "<string>",
"companyAvatar": "<string>",
"companyZip": "<string>",
"secondaryColor": "<string>"
},
"isOffline": true,
"linkType": "PERSONAL_LINK",
"allUsersBusyTimes": [
{
"meetingsUser": {
"isSalesStarter": true,
"calendarProvider": "<string>",
"id": "<string>",
"userId": "<string>",
"userProfile": {
"firstName": "<string>",
"lastName": "<string>",
"fullName": "<string>",
"email": "<string>"
}
},
"busyTimes": [
{
"start": 123,
"end": 123
}
],
"isOffline": true
}
]
}
Get details about the initial information necessary for a meeting scheduler.
curl --request GET \
--url https://api.hubapi.com/scheduler/v3/meetings/meeting-links/book/{slug} \
--header 'Authorization: Bearer <token>'
{
"linkId": "<string>",
"customParams": {
"redirectUrl": "<string>",
"startTimeIncrementMinutes": "<string>",
"guestSettings": {
"maxGuestCount": 123,
"canAddGuests": true
},
"language": "<string>",
"availability": {},
"locale": "<string>",
"ownerPrioritized": true,
"legalConsentOptions": {
"legitimateInterestSubscriptionTypes": [
123
],
"processingConsentCheckboxLabel": "<string>",
"communicationConsentText": "<string>",
"legitimateInterestLegalBasis": "LEGITIMATE_INTEREST_PQL",
"processingConsentType": "<string>",
"privacyPolicyText": "<string>",
"processingConsentText": "<string>",
"communicationConsentCheckboxes": [
{
"communicationTypeId": "<string>",
"label": "<string>",
"required": true
}
],
"processingConsentFooterText": "<string>",
"isLegitimateInterest": true
},
"welcomeScreenInfo": {
"useCompanyLogo": true,
"description": "<string>",
"showWelcomeScreen": true,
"title": "<string>",
"logoUrl": "<string>"
},
"meetingBufferTime": 123,
"weeksToAdvertise": 123,
"displayInfo": {
"publicDisplayAvatarOption": "<string>",
"companyAvatar": "<string>",
"avatar": "<string>",
"headline": "<string>"
},
"durations": [
123
],
"location": "<string>",
"formFields": [
{
"isRequired": true,
"name": "<string>",
"options": [
{
"hidden": true,
"displayOrder": 123,
"doubleData": 123,
"description": "<string>",
"readOnly": true,
"label": "<string>",
"value": "<string>"
}
],
"isCustom": true,
"label": "<string>",
"type": "<string>",
"fieldType": "<string>"
}
],
"legalConsentEnabled": true,
"customAvailabilityEndDate": 123,
"customAvailabilityStartDate": 123
},
"linkAvailability": {
"hasMore": true,
"linkAvailabilityByDuration": {}
},
"brandingMetadata": {
"logoHeight": 123,
"logoAltText": "<string>",
"companyCity": "<string>",
"companyAddressLine1": "<string>",
"showSalesAd": true,
"companyAddressLine2": "<string>",
"accentColor": "<string>",
"companyName": "<string>",
"companyState": "<string>",
"primaryColor": "<string>",
"showMarketingAd": true,
"accent2Color": "<string>",
"companyDomain": "<string>",
"logoUrl": "<string>",
"logoWidth": 123,
"companyCountry": "<string>",
"companyAvatar": "<string>",
"companyZip": "<string>",
"secondaryColor": "<string>"
},
"isOffline": true,
"linkType": "PERSONAL_LINK",
"allUsersBusyTimes": [
{
"meetingsUser": {
"isSalesStarter": true,
"calendarProvider": "<string>",
"id": "<string>",
"userId": "<string>",
"userProfile": {
"firstName": "<string>",
"lastName": "<string>",
"fullName": "<string>",
"email": "<string>"
}
},
"busyTimes": [
{
"start": 123,
"end": 123
}
],
"isOffline": true
}
]
}
scheduler.meetings.meeting-link.read
The access token received from the authorization server in the OAuth 2.0 flow.
successful operation
The response is of type object
.
Was this page helpful?