Get /scheduler/v3/meetings/meeting Links/book/{slug}

List booking information

GET/scheduler/v3/meetings/meeting-links/book/{slug}

Use it in a workflow

Add a step and choose the HubSpot connector.
Pick the Get /scheduler/v3/meetings/meeting Links/book/{slug} action (under Meetings).
Fill in the fields below, then reference the result from later steps as {{getSchedulerV3MeetingsMeetingLinksBookSlug.response.data}}.

Request

Path parameters

slugstringrequired

Query parameters

timezonestringrequired

Response

Returns 200 with an object. Read it in later steps with {{getSchedulerV3MeetingsMeetingLinksBookSlug.response.data.<field>}}.

allUsersBusyTimesarray<object>

busyTimesarray<object>required2 fields

isOfflinebooleanrequired

Whether the user is offline.

meetingsUserobjectrequired5 fields

brandingMetadataobject

accent2Colorstring

The secondary accent color used in branding.

accentColorstring

The primary accent color used in branding.

companyAddressLine1string

The first line of the company's address.

companyAddressLine2string

The second line of the company's address.

companyAvatarstring

The URL of the company's avatar image.

companyCitystring

The city where the company is located.

companyCountrystring

The country where the company is located.

companyDomainstring

The domain of the company's website.

companyNamestring

The name of the company.

companyStatestring

The state where the company is located.

companyZipstring

The ZIP code of the company's location.

logoAltTextstringrequired

The alternative text for the current logo.

logoHeightinteger (int32)

The height of the logo in pixels.

logoUrlstring

The URL of a custom logo image.

logoWidthinteger (int32)

The width of the logo in pixels.

primaryColorstring

The primary color used in branding.

secondaryColorstring

The secondary color used in branding.

showMarketingAdbooleanrequired

Whether Hubspot Marketing ads are shown.

showSalesAdbooleanrequired

Whether Hubspot Sales ads are shown.

customParamsobject

availabilityobjectrequired

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).

customAvailabilityEndDateinteger (int64)

The end date for a meeting link's custom availability window, represented as Unix time in milliseconds.

customAvailabilityStartDateinteger (int64)

The start date for a meeting link's custom availability window, represented as Unix time in milliseconds.

displayInfoobject4 fields

durationsarray<integer (int64)>required

formFieldsarray<object>required7 fields

guestSettingsobject2 fields

languagestring

The language setting used for the meeting link.

legalConsentEnabledbooleanrequired

Whether the legal consent checkbox is displayed during meeting booking.

legalConsentOptionsobject10 fields

localestring

The locale setting used for formatting dates and times in the meeting link.

locationstring

The physical or virtual location where the meeting will take place.

meetingBufferTimeinteger (int64)required

The minimum buffer time in milliseconds between consecutive meetings.

ownerPrioritizedbooleanrequired

Indicates whether the meeting owner is prioritized during booking. Only applies to link types of ROUND_ROBIN.

redirectUrlstring

The URL to redirect to after a meeting is booked.

startTimeIncrementMinutesstringrequired

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.

One ofFIFTEENFIVEFORTY_FIVEMEETING_DURATIONNINETYONE_HUNDRED_TWENTYSIXTYTENTHIRTYTWENTY

weeksToAdvertiseinteger (int32)required

Legacy property that indicates the number of weeks in advance that availability is advertised. May be outdated or superseded by other properties.

welcomeScreenInfoobject5 fields

isOfflineboolean

Whether the meeting was booked offline, meaning no associated calendar event was created.

linkAvailabilityobject

hasMorebooleanrequired

Whether there are more available meeting times beyond the returned set.

linkAvailabilityByDurationobjectrequired

Available booking slots for the meeting, grouped by the duration.

linkIdstring

The unique identifier for the meeting link.

linkTypestring

The type of the meeting link. Accepted values are: GROUP_CALENDAR, PERSONAL_LINK, ROUND_ROBIN_CALENDAR.

One ofGROUP_CALENDARPERSONAL_LINKROUND_ROBIN_CALENDAR

json

{
  "allUsersBusyTimes": [
    {
      "busyTimes": [
        {
          "end": 0,
          "start": 0
        }
      ],
      "isOffline": false,
      "meetingsUser": {
        "calendarProvider": "EXCHANGE",
        "id": "string",
        "isSalesStarter": false,
        "userId": "string",
        "userProfile": {
          "email": "string",
          "firstName": "string",
          "fullName": "string",
          "lastName": "string"
        }
      }
    }
  ],
  "customParams": {
    "availability": {},
    "durations": [
      0
    ],
    "formFields": [
      {
        "fieldType": "string",
        "isCustom": false,
        "isRequired": false,
        "label": "string",
        "name": "string",
        "options": [
          {
            "description": "string",
            "displayOrder": 0,
            "doubleData": 0,
            "hidden": false,
            "label": "string",
            "readOnly": false,
            "value": "string"
          }
        ],
        "type": "string"
      }
    ],
    "legalConsentEnabled": false,
    "meetingBufferTime": 0,
    "ownerPrioritized": false,
    "startTimeIncrementMinutes": "FIFTEEN",
    "weeksToAdvertise": 0,
    "customAvailabilityEndDate": 0,
    "customAvailabilityStartDate": 0,
    "displayInfo": {
      "avatar": "string",
      "companyAvatar": "string",
      "headline": "string",
      "publicDisplayAvatarOption": "COMPANY_LOGO"
    },
    "guestSettings": {
      "canAddGuests": false,
      "maxGuestCount": 0
    }
  },
  "isOffline": false,
  "linkId": "string",
  "linkType": "GROUP_CALENDAR",
  "brandingMetadata": {
    "logoAltText": "string",
    "showMarketingAd": false,
    "showSalesAd": false,
    "accent2Color": "string",
    "accentColor": "string",
    "companyAddressLine1": "string",
    "companyAddressLine2": "string",
    "companyAvatar": "string",
    "companyCity": "string",
    "companyCountry": "string",
    "companyDomain": "string",
    "companyName": "string"
  },
  "linkAvailability": {
    "hasMore": false,
    "linkAvailabilityByDuration": {}
  }
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.

Was this page helpful?