cURL
curl --request GET \
--url 'https://api.obvlo.com/v2/orgs/{orgId}/host-home?key='import requests
url = "https://api.obvlo.com/v2/orgs/{orgId}/host-home?key="
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.obvlo.com/v2/orgs/{orgId}/host-home?key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"host": {
"id": "<string>",
"name": "<string>",
"orgId": "<string>",
"geoLocation": [
123
],
"primaryLocation": {
"displayName": "<string>",
"address": "<string>",
"locationId": "<string>",
"measurement": "<string>",
"geoLocation": {
"lat": 123,
"lng": 123
}
},
"searchConfig": {
"searchRadius": 123,
"guideRanking": "<string>",
"listingRanking": "<string>",
"maxSearchResults": 123
},
"languageCodes": [
"<string>"
],
"defaultLanguageCode": "<string>",
"currencyCode": "<string>",
"currencySymbol": "<string>",
"timeZoneName": "<string>",
"stage": "<string>",
"analytics": {
"googleTagId": "<string>",
"facebookPixelId": "<string>"
},
"feedback": {
"npsWatermark": 123,
"csatLevels": {
"totalEvents": 123,
"prsClicks": 123,
"totalPlaceViews": 123,
"totalPicklistViews": 123,
"type": "<string>",
"validTags": [
"<string>"
],
"askFeedback": true,
"minSessionDuration": 123,
"minSessions": 123
}
},
"integrations": {
"oracleOhip": {
"clientId": "<string>",
"clientSecret": "<string>",
"username": "<string>",
"password": "<string>",
"hotelId": "<string>",
"hostName": "<string>"
},
"mews": {
"accessToken": "<string>",
"clientToken": "<string>",
"platformAddress": "<string>"
}
},
"tsAPIKey": {
"id": 123,
"value": "<string>",
"createdAt": 123,
"host": "<string>"
},
"uiConfig": {
"banner": {
"image": {
"url": "<string>",
"path": "<string>",
"width": 123,
"height": 123,
"classifications": [
"<string>"
],
"caption": "<string>",
"type": "<string>"
},
"text": "<string>",
"backgroundColor": "<string>",
"textColor": "<string>",
"ctaLabel": "<string>",
"ctaIconClass": "<string>",
"showLogo": true,
"showLocation": true,
"showWeather": true
},
"loadingBanner": {
"image": {
"url": "<string>",
"path": "<string>",
"width": 123,
"height": 123,
"classifications": [
"<string>"
],
"caption": "<string>",
"type": "<string>"
},
"backgroundColor": "<string>",
"textColor": "<string>"
},
"neighborhoods": true,
"prsModules": [
"<string>"
],
"contact": {
"email": "<string>",
"phone": "<string>",
"website": "<string>"
},
"customMapMarkerUrl": "<string>",
"featured": {
"label": "<string>",
"shortLabel": "<string>",
"iconUrl": "<string>",
"colors": {
"name": "<string>",
"hex": "<string>",
"darkContrast": true,
"hexContrast": "<string>"
},
"cornerRadius": {}
}
},
"branding": {
"colors": {
"primary": "<string>",
"background": "<string>"
},
"fonts": {
"primary": "<string>",
"secondary": "<string>",
"letterSpacingHeaders": 123,
"letterSpacingBody": 123,
"lineHeightHeaders": 123,
"lineHeightBody": 123,
"fontSizeHeaders": 123,
"fontSizeBody": 123
},
"theme": {
"colors": {
"primary": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary100": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary200": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary300": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary400": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary500": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary600": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary700": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary800": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary900": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary100": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary200": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary300": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary400": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary500": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary600": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary700": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary800": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary900": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"background": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"backgroundContrast": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"success": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"warning": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"error": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"highEmphasis": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"mediumEmphasis": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"disabled": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"onSurface": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"onSurfaceHighEmphasis": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"onSurfaceMediumEmphasis": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"onSurfaceDisabled": {
"textColor": "<string>",
"backgroundColor": "<string>"
}
},
"fonts": {
"desktop": {
"header1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header3": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header4": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header5": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header6": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"subtitle1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"subtitle2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"body1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"body2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"button": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"caption": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"captionBold": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"overline": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"overlineBold": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
}
},
"mobile": {
"header1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header3": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header4": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header5": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header6": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"subtitle1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"subtitle2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"body1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"body2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"button": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"caption": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"captionBold": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"overline": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"overlineBold": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
}
},
"customFonts": [
{
"name": "<string>",
"url": "<string>"
}
]
}
},
"logos": {
"dark": "<string>",
"light": "<string>",
"attrs": {
"width": 123,
"height": 123
}
},
"customFont": {
"name": "<string>",
"url": "<string>"
},
"favicon": "<string>"
},
"logos": [
{
"description": "<string>",
"file": {
"url": "<string>",
"path": "<string>",
"width": 123,
"height": 123,
"classifications": [
"<string>"
],
"caption": "<string>",
"type": "<string>"
},
"height": 123,
"name": "<string>",
"url": "<string>",
"width": 123
}
],
"pages": [
{
"label": "<string>",
"type": "<string>",
"enabled": true,
"path": "<string>",
"icons": {
"active": "<string>",
"inactive": "<string>"
}
}
],
"weather": {
"id": 123,
"weatherLocation": "<string>",
"temperature": 123,
"tempMetric": "<string>",
"icon": "<string>"
},
"perks": {
"header": "<string>",
"sections": [
"<string>"
]
},
"socialMedia": [
{
"name": "<string>",
"url": "<string>",
"icon": "<string>",
"target": "<string>"
}
],
"travellerArchetypes": [
{
"id": "<string>",
"name": "<string>",
"travelPurpose": [
"<string>"
],
"activityTags": [
"<string>"
],
"archetypeTags": [
"<string>"
],
"codeNames": [
"<string>"
],
"travellerTypes": [
"<string>"
]
}
],
"redirectUrls": [
{
"url": "<string>",
"label": "<string>",
"type": "<string>",
"enabled": true
}
],
"linkTree": {
"sections": [
{
"title": "<string>",
"links": [
{
"label": "<string>",
"url": "<string>",
"icon": "<string>",
"copyCaption": true,
"type": "<string>",
"enabled": true,
"trackingEventName": "<string>"
}
]
}
]
},
"activeIntegrations": [
"<string>"
],
"embeddedConfigs": [
{
"id": "<string>",
"createdAt": 123,
"name": "<string>",
"updatedAt": 123,
"updatedBy": "<string>",
"createdBy": "<string>",
"customIconUrl": "<string>",
"description": "<string>",
"kioskMode": true,
"disableJustForYou": true,
"disableAnimations": true,
"disableSavedListings": true,
"modules": [],
"requirePreferences": true,
"menuOptions": [
{
"label": "<string>",
"iconClass": "<string>"
}
],
"containerOptions": {
"padding": {
"top": 123,
"right": 123,
"bottom": 123,
"left": 123
},
"maxWidth": 123,
"map": {
"width": "<string>",
"height": "<string>"
}
},
"drawer": true,
"drawerDelayMs": 123,
"gridRows": 123,
"gridRowsMobile": 123,
"hideTravel": true,
"hideGuideHeader": true,
"hideLanguageSelector": true,
"lang": "<string>",
"cornerRadius": {
"card": {
"topLeft": 123,
"topRight": 123,
"bottomLeft": 123,
"bottomRight": 123
},
"button": {
"topLeft": 123,
"topRight": 123,
"bottomLeft": 123,
"bottomRight": 123
}
},
"experiments": {}
}
]
},
"guides": {
"results": [
{
"contentType": "<string>",
"description": {},
"featured": false,
"geoLocation": [
123
],
"hostIds": [
"<string>"
],
"id": "<string>",
"keywords": {},
"languageCodes": [
"<string>"
],
"listingIds": [
"<string>"
],
"name": {},
"updatedAt": 123,
"attribution": {},
"centerLocation": {},
"coverImage": {
"attributions": [
"<string>"
],
"category": "<string>",
"id": "<string>",
"images": [
{
"size": "<string>",
"url": "<string>"
}
],
"keywords": [
"<string>"
],
"isGenerated": true,
"genDescription": "<string>",
"license": "<string>",
"isLicensed": true
},
"introText": {},
"preferences": {},
"priority": 1,
"status": "<string>",
"geoDistance": 123,
"listings": [
{
"address": {},
"contentType": "<string>",
"featured": true,
"geoLocation": [
123
],
"guideIds": [
"<string>"
],
"hostIds": [
"<string>"
],
"id": "<string>",
"name": {},
"photos": [
{
"attributions": [
"<string>"
],
"category": "<string>",
"id": "<string>",
"images": [
{
"size": "<string>",
"url": "<string>"
}
],
"keywords": [
"<string>"
],
"isGenerated": true,
"genDescription": "<string>",
"license": "<string>",
"isLicensed": true
}
],
"score": 123,
"searchId": "<string>",
"status": "<string>",
"summary": {},
"activityTags": {},
"additionalTextAttributes": {},
"category": {},
"currencyCode": "<string>",
"deliveryApps": [
{
"url": "<string>",
"type": "<string>"
}
],
"embeds": [
{
"code": "<string>",
"type": "<string>",
"provider": "<string>"
}
],
"googleId": "<string>",
"googleMapsUrl": "<string>",
"googleRating": 123,
"integratedCategories": {},
"keywords": {},
"languageCodes": [
"<string>"
],
"neighborhood": "<string>",
"openingHours": {
"isUnavailable": true,
"nextCloseTime": "<string>",
"openNow": true,
"weekday_text": [
"<string>"
],
"periods": [
{
"open": {
"day": 123,
"time": "<string>",
"hours": 123,
"minutes": 123,
"hour": 123,
"minute": 123
},
"close": {
"day": 123,
"time": "<string>",
"hours": 123,
"minutes": 123,
"hour": 123,
"minute": 123
}
}
]
},
"phoneNumber": "<string>",
"planVisit": {},
"preferences": {},
"priceLevel": 123,
"priceLevelText": {},
"priority": 123,
"searchTerms": [
"<string>"
],
"serviceTypes": [
"<string>"
],
"socialMedia": [
{
"name": "<string>",
"url": "<string>",
"icon": "<string>",
"target": "<string>"
}
],
"tableBooking": {
"url": "<string>",
"type": "<string>"
},
"tagline": {},
"tripAdvisorRating": 123,
"tripAdvisorUrl": "<string>",
"websiteUrl": "<string>",
"whatToExpect": {},
"geoDistance": 123,
"additionalData": {
"dateTimestamp": 123,
"date": {
"start_date": "<string>",
"when": "<string>"
},
"venue": {
"link": "<string>",
"name": "<string>",
"reviews": 123
},
"ticket_info": [
{
"link": "<string>",
"link_type": "<string>",
"source": "<string>"
}
]
}
}
]
}
],
"total": 123,
"pages": 123
},
"geoareas": {
"results": [
{
"id": "<string>",
"hostIds": [
"<string>"
],
"status": "<string>",
"geoLocation": [
123
],
"address": {},
"displayName": {},
"area": {},
"headline": {},
"description": {},
"keywords": {},
"photos": [
{
"attributions": [
"<string>"
],
"category": "<string>",
"id": "<string>",
"images": [
{
"size": "<string>",
"url": "<string>"
}
],
"keywords": [
"<string>"
],
"isGenerated": true,
"genDescription": "<string>",
"license": "<string>",
"isLicensed": true
}
],
"radius": 123,
"languageCodes": [
"<string>"
],
"geoDistance": 123
}
],
"total": 123,
"pages": 123
}
}V2 Multilingual
Get v2orgs host home
Single-call bootstrap for a host home screen. Returns the host profile alongside the first page of guides, each with nested listings. Preference filters (userCategory, tripType, userInterests) are applied to both guide and listing ranking.
GET
/
v2
/
orgs
/
{orgId}
/
host-home
cURL
curl --request GET \
--url 'https://api.obvlo.com/v2/orgs/{orgId}/host-home?key='import requests
url = "https://api.obvlo.com/v2/orgs/{orgId}/host-home?key="
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.obvlo.com/v2/orgs/{orgId}/host-home?key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"host": {
"id": "<string>",
"name": "<string>",
"orgId": "<string>",
"geoLocation": [
123
],
"primaryLocation": {
"displayName": "<string>",
"address": "<string>",
"locationId": "<string>",
"measurement": "<string>",
"geoLocation": {
"lat": 123,
"lng": 123
}
},
"searchConfig": {
"searchRadius": 123,
"guideRanking": "<string>",
"listingRanking": "<string>",
"maxSearchResults": 123
},
"languageCodes": [
"<string>"
],
"defaultLanguageCode": "<string>",
"currencyCode": "<string>",
"currencySymbol": "<string>",
"timeZoneName": "<string>",
"stage": "<string>",
"analytics": {
"googleTagId": "<string>",
"facebookPixelId": "<string>"
},
"feedback": {
"npsWatermark": 123,
"csatLevels": {
"totalEvents": 123,
"prsClicks": 123,
"totalPlaceViews": 123,
"totalPicklistViews": 123,
"type": "<string>",
"validTags": [
"<string>"
],
"askFeedback": true,
"minSessionDuration": 123,
"minSessions": 123
}
},
"integrations": {
"oracleOhip": {
"clientId": "<string>",
"clientSecret": "<string>",
"username": "<string>",
"password": "<string>",
"hotelId": "<string>",
"hostName": "<string>"
},
"mews": {
"accessToken": "<string>",
"clientToken": "<string>",
"platformAddress": "<string>"
}
},
"tsAPIKey": {
"id": 123,
"value": "<string>",
"createdAt": 123,
"host": "<string>"
},
"uiConfig": {
"banner": {
"image": {
"url": "<string>",
"path": "<string>",
"width": 123,
"height": 123,
"classifications": [
"<string>"
],
"caption": "<string>",
"type": "<string>"
},
"text": "<string>",
"backgroundColor": "<string>",
"textColor": "<string>",
"ctaLabel": "<string>",
"ctaIconClass": "<string>",
"showLogo": true,
"showLocation": true,
"showWeather": true
},
"loadingBanner": {
"image": {
"url": "<string>",
"path": "<string>",
"width": 123,
"height": 123,
"classifications": [
"<string>"
],
"caption": "<string>",
"type": "<string>"
},
"backgroundColor": "<string>",
"textColor": "<string>"
},
"neighborhoods": true,
"prsModules": [
"<string>"
],
"contact": {
"email": "<string>",
"phone": "<string>",
"website": "<string>"
},
"customMapMarkerUrl": "<string>",
"featured": {
"label": "<string>",
"shortLabel": "<string>",
"iconUrl": "<string>",
"colors": {
"name": "<string>",
"hex": "<string>",
"darkContrast": true,
"hexContrast": "<string>"
},
"cornerRadius": {}
}
},
"branding": {
"colors": {
"primary": "<string>",
"background": "<string>"
},
"fonts": {
"primary": "<string>",
"secondary": "<string>",
"letterSpacingHeaders": 123,
"letterSpacingBody": 123,
"lineHeightHeaders": 123,
"lineHeightBody": 123,
"fontSizeHeaders": 123,
"fontSizeBody": 123
},
"theme": {
"colors": {
"primary": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary100": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary200": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary300": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary400": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary500": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary600": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary700": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary800": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"primary900": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary100": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary200": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary300": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary400": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary500": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary600": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary700": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary800": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"secondary900": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"background": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"backgroundContrast": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"success": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"warning": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"error": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"highEmphasis": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"mediumEmphasis": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"disabled": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"onSurface": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"onSurfaceHighEmphasis": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"onSurfaceMediumEmphasis": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"onSurfaceDisabled": {
"textColor": "<string>",
"backgroundColor": "<string>"
}
},
"fonts": {
"desktop": {
"header1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header3": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header4": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header5": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header6": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"subtitle1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"subtitle2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"body1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"body2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"button": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"caption": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"captionBold": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"overline": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"overlineBold": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
}
},
"mobile": {
"header1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header3": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header4": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header5": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"header6": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"subtitle1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"subtitle2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"body1": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"body2": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"button": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"caption": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"captionBold": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"overline": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
},
"overlineBold": {
"name": "<string>",
"font": "<string>",
"weight": 123,
"size": 123,
"lineHeight": 123,
"letterSpacing": 123
}
},
"customFonts": [
{
"name": "<string>",
"url": "<string>"
}
]
}
},
"logos": {
"dark": "<string>",
"light": "<string>",
"attrs": {
"width": 123,
"height": 123
}
},
"customFont": {
"name": "<string>",
"url": "<string>"
},
"favicon": "<string>"
},
"logos": [
{
"description": "<string>",
"file": {
"url": "<string>",
"path": "<string>",
"width": 123,
"height": 123,
"classifications": [
"<string>"
],
"caption": "<string>",
"type": "<string>"
},
"height": 123,
"name": "<string>",
"url": "<string>",
"width": 123
}
],
"pages": [
{
"label": "<string>",
"type": "<string>",
"enabled": true,
"path": "<string>",
"icons": {
"active": "<string>",
"inactive": "<string>"
}
}
],
"weather": {
"id": 123,
"weatherLocation": "<string>",
"temperature": 123,
"tempMetric": "<string>",
"icon": "<string>"
},
"perks": {
"header": "<string>",
"sections": [
"<string>"
]
},
"socialMedia": [
{
"name": "<string>",
"url": "<string>",
"icon": "<string>",
"target": "<string>"
}
],
"travellerArchetypes": [
{
"id": "<string>",
"name": "<string>",
"travelPurpose": [
"<string>"
],
"activityTags": [
"<string>"
],
"archetypeTags": [
"<string>"
],
"codeNames": [
"<string>"
],
"travellerTypes": [
"<string>"
]
}
],
"redirectUrls": [
{
"url": "<string>",
"label": "<string>",
"type": "<string>",
"enabled": true
}
],
"linkTree": {
"sections": [
{
"title": "<string>",
"links": [
{
"label": "<string>",
"url": "<string>",
"icon": "<string>",
"copyCaption": true,
"type": "<string>",
"enabled": true,
"trackingEventName": "<string>"
}
]
}
]
},
"activeIntegrations": [
"<string>"
],
"embeddedConfigs": [
{
"id": "<string>",
"createdAt": 123,
"name": "<string>",
"updatedAt": 123,
"updatedBy": "<string>",
"createdBy": "<string>",
"customIconUrl": "<string>",
"description": "<string>",
"kioskMode": true,
"disableJustForYou": true,
"disableAnimations": true,
"disableSavedListings": true,
"modules": [],
"requirePreferences": true,
"menuOptions": [
{
"label": "<string>",
"iconClass": "<string>"
}
],
"containerOptions": {
"padding": {
"top": 123,
"right": 123,
"bottom": 123,
"left": 123
},
"maxWidth": 123,
"map": {
"width": "<string>",
"height": "<string>"
}
},
"drawer": true,
"drawerDelayMs": 123,
"gridRows": 123,
"gridRowsMobile": 123,
"hideTravel": true,
"hideGuideHeader": true,
"hideLanguageSelector": true,
"lang": "<string>",
"cornerRadius": {
"card": {
"topLeft": 123,
"topRight": 123,
"bottomLeft": 123,
"bottomRight": 123
},
"button": {
"topLeft": 123,
"topRight": 123,
"bottomLeft": 123,
"bottomRight": 123
}
},
"experiments": {}
}
]
},
"guides": {
"results": [
{
"contentType": "<string>",
"description": {},
"featured": false,
"geoLocation": [
123
],
"hostIds": [
"<string>"
],
"id": "<string>",
"keywords": {},
"languageCodes": [
"<string>"
],
"listingIds": [
"<string>"
],
"name": {},
"updatedAt": 123,
"attribution": {},
"centerLocation": {},
"coverImage": {
"attributions": [
"<string>"
],
"category": "<string>",
"id": "<string>",
"images": [
{
"size": "<string>",
"url": "<string>"
}
],
"keywords": [
"<string>"
],
"isGenerated": true,
"genDescription": "<string>",
"license": "<string>",
"isLicensed": true
},
"introText": {},
"preferences": {},
"priority": 1,
"status": "<string>",
"geoDistance": 123,
"listings": [
{
"address": {},
"contentType": "<string>",
"featured": true,
"geoLocation": [
123
],
"guideIds": [
"<string>"
],
"hostIds": [
"<string>"
],
"id": "<string>",
"name": {},
"photos": [
{
"attributions": [
"<string>"
],
"category": "<string>",
"id": "<string>",
"images": [
{
"size": "<string>",
"url": "<string>"
}
],
"keywords": [
"<string>"
],
"isGenerated": true,
"genDescription": "<string>",
"license": "<string>",
"isLicensed": true
}
],
"score": 123,
"searchId": "<string>",
"status": "<string>",
"summary": {},
"activityTags": {},
"additionalTextAttributes": {},
"category": {},
"currencyCode": "<string>",
"deliveryApps": [
{
"url": "<string>",
"type": "<string>"
}
],
"embeds": [
{
"code": "<string>",
"type": "<string>",
"provider": "<string>"
}
],
"googleId": "<string>",
"googleMapsUrl": "<string>",
"googleRating": 123,
"integratedCategories": {},
"keywords": {},
"languageCodes": [
"<string>"
],
"neighborhood": "<string>",
"openingHours": {
"isUnavailable": true,
"nextCloseTime": "<string>",
"openNow": true,
"weekday_text": [
"<string>"
],
"periods": [
{
"open": {
"day": 123,
"time": "<string>",
"hours": 123,
"minutes": 123,
"hour": 123,
"minute": 123
},
"close": {
"day": 123,
"time": "<string>",
"hours": 123,
"minutes": 123,
"hour": 123,
"minute": 123
}
}
]
},
"phoneNumber": "<string>",
"planVisit": {},
"preferences": {},
"priceLevel": 123,
"priceLevelText": {},
"priority": 123,
"searchTerms": [
"<string>"
],
"serviceTypes": [
"<string>"
],
"socialMedia": [
{
"name": "<string>",
"url": "<string>",
"icon": "<string>",
"target": "<string>"
}
],
"tableBooking": {
"url": "<string>",
"type": "<string>"
},
"tagline": {},
"tripAdvisorRating": 123,
"tripAdvisorUrl": "<string>",
"websiteUrl": "<string>",
"whatToExpect": {},
"geoDistance": 123,
"additionalData": {
"dateTimestamp": 123,
"date": {
"start_date": "<string>",
"when": "<string>"
},
"venue": {
"link": "<string>",
"name": "<string>",
"reviews": 123
},
"ticket_info": [
{
"link": "<string>",
"link_type": "<string>",
"source": "<string>"
}
]
}
}
]
}
],
"total": 123,
"pages": 123
},
"geoareas": {
"results": [
{
"id": "<string>",
"hostIds": [
"<string>"
],
"status": "<string>",
"geoLocation": [
123
],
"address": {},
"displayName": {},
"area": {},
"headline": {},
"description": {},
"keywords": {},
"photos": [
{
"attributions": [
"<string>"
],
"category": "<string>",
"id": "<string>",
"images": [
{
"size": "<string>",
"url": "<string>"
}
],
"keywords": [
"<string>"
],
"isGenerated": true,
"genDescription": "<string>",
"license": "<string>",
"isLicensed": true
}
],
"radius": 123,
"languageCodes": [
"<string>"
],
"geoDistance": 123
}
],
"total": 123,
"pages": 123
}
}Authorizations
Path Parameters
Organization Account Number
Query Parameters
Unique profile identifier
BCP-47 language code (e.g. en-GB). When provided, localizable fields are returned as a single string instead of a language map.
Latitude and Longitude as the center of search, comma separated. Ex: 55.953251,-3.188267
Radius in meters from center of search
Adding a user category will only return guides that match the category. Possible values: business, family, friends, solo, or couples
Adding a trip type will rank guides based on trip type suitability. Possible values: business, pleasure, or both. Default: both
Comma-separated list of user interests to rank results by weighted match. Available values can be retrieved from the /getPersonalizationOptions endpoint.
Ranking strategy. One of: 'distance', 'relevance', 'score'
Filter guides by type. 'featured' returns only featured guides; 'guide' and 'neighbourhood' return all guides (neighbourhoods are returned via the geoareas field).
Available options:
guide, neighbourhood, featured Page index for guide results
Number of guides per page, maximum 20
Maximum number of listings to include per guide
Page index for geo area results
Number of geo areas per page, maximum 20
⌘I