{ "openapi": "3.0.3", "info": { "title": "Obvlo Content Engine", "description": "Obvlo Content Engine API", "version": "4.0.0" }, "servers": [ { "url": "https://api.obvlo.com" } ], "components": { "securitySchemes": { "api_key": { "type": "apiKey", "name": "key", "in": "query" } }, "schemas": { "SitePageSlugEntry": { "type": "object", "properties": { "pageId": { "type": "string" }, "pageType": { "type": "string", "enum": [ "Root", "Destination", "Guide", "Area" ] }, "slug": { "type": "string" }, "homepageSlug": { "type": "string", "nullable": true }, "segments": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string" } }, "destinationId": { "type": "string", "nullable": true }, "guideId": { "type": "string", "nullable": true }, "locationId": { "type": "string", "nullable": true } }, "required": [ "pageId", "pageType", "slug", "homepageSlug", "segments", "parentIds", "destinationId", "guideId", "locationId" ], "additionalProperties": false }, "SitePageSlugTreeEntry": { "allOf": [ { "$ref": "#/components/schemas/SitePageSlugEntry" }, { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/components/schemas/SitePageSlugEntry" } } }, "required": [ "children" ], "additionalProperties": false } ] }, "SitePageSlugMatchesResponse": { "type": "object", "properties": { "siteId": { "type": "string" }, "mode": { "type": "string", "enum": [ "matches" ] }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/SitePageSlugEntry" } } }, "required": [ "siteId", "mode", "matches" ], "additionalProperties": false }, "SitePageSlugTreeResponse": { "type": "object", "properties": { "siteId": { "type": "string" }, "mode": { "type": "string", "enum": [ "tree" ] }, "tree": { "type": "array", "items": { "$ref": "#/components/schemas/SitePageSlugTreeEntry" } } }, "required": [ "siteId", "mode", "tree" ], "additionalProperties": false } } }, "paths": { "/v2/orgs/{orgId}/guide-search": { "get": { "tags": [ "V2 Multilingual" ], "description": "Search for guides matching criteria. Returns matching guides with optional nested listings.", "operationId": "v2SearchGuides", "parameters": [ { "name": "orgId", "in": "path", "required": true, "description": "Organization Account Number", "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "required": false, "description": "Unique profile identifier", "schema": { "type": "string" } }, { "name": "searchQuery", "in": "query", "required": false, "description": "A text query containing a name and optionally a location", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Page index used to get next page of responses", "schema": { "type": "integer" } }, { "name": "hitsPerPage", "in": "query", "required": false, "description": "Hits per page, maximum 20", "schema": { "type": "integer" } }, { "name": "latlng", "in": "query", "required": false, "description": "Latitude and Longitude as the center of search, comma separated. Ex: 55.953251,-3.188267", "schema": { "type": "string" } }, { "name": "radius", "in": "query", "required": false, "description": "Radius in meters from center of search", "schema": { "type": "number" } }, { "name": "userCategory", "in": "query", "required": false, "description": "Adding a user category will only return guides that match the category. Possible values: business, family, friends, solo, or couples", "schema": { "type": "string" } }, { "name": "tripType", "in": "query", "required": false, "description": "Adding a trip type will rank guides based on trip type suitability. Possible values: business, pleasure, or both. Default: both", "schema": { "type": "string" } }, { "name": "userInterests", "in": "query", "required": false, "description": "Comma-separated list of user interests to rank results by weighted match. Available values can be retrieved from the /getPersonalizationOptions endpoint.", "schema": { "type": "string" } }, { "name": "includeListings", "in": "query", "required": false, "description": "Whether to include listings in the guide response", "schema": { "type": "boolean" } }, { "name": "maxListingsPerGuide", "in": "query", "required": false, "description": "Maximum number of listings to include per guide", "schema": { "type": "integer" } }, { "name": "rankBy", "in": "query", "required": false, "description": "Ranking strategy. One of: 'distance', 'relevance', 'score'", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "BCP-47 language code (e.g. en-GB). When provided, localizable fields are returned as a single string instead of a language map.", "schema": { "type": "string" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "attribution": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "centerLocation": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "contentType": { "type": "string" }, "coverImage": { "type": "object", "properties": { "attributions": { "type": "array", "items": { "type": "string" } }, "category": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "object", "properties": { "size": { "type": "string" }, "url": { "type": "string" } }, "required": [ "size", "url" ], "additionalProperties": false } }, "keywords": { "type": "array", "items": { "type": "string" } }, "isGenerated": { "type": "boolean" }, "genDescription": { "type": "string" }, "license": { "type": "string" }, "isLicensed": { "type": "boolean" } }, "required": [ "attributions", "category", "id", "images", "keywords" ], "additionalProperties": false }, "description": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "featured": { "default": false, "type": "boolean" }, "geoLocation": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "hostIds": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "introText": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "keywords": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": { "type": "string" } } ] }, "languageCodes": { "type": "array", "items": { "type": "string" } }, "listingIds": { "type": "array", "items": { "type": "string" } }, "name": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "preferences": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "timeOfDay": { "type": "array", "items": { "type": "string" } }, "timeOfYear": { "type": "array", "items": { "type": "string" } }, "tripType": { "type": "array", "items": { "type": "string" } }, "userCategories": { "type": "array", "items": { "type": "string" } }, "userInterests": { "type": "array", "items": { "type": "string" } }, "weatherType": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, { "type": "object", "properties": { "timeOfDay": { "type": "array", "items": { "type": "string" } }, "timeOfYear": { "type": "array", "items": { "type": "string" } }, "tripType": { "type": "array", "items": { "type": "string" } }, "userCategories": { "type": "array", "items": { "type": "string" } }, "userInterests": { "type": "array", "items": { "type": "string" } }, "weatherType": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "priority": { "type": "number", "minimum": 0 }, "status": { "type": "string" }, "updatedAt": { "type": "number" }, "geoDistance": { "type": "number" }, "listings": { "type": "array", "items": { "type": "object", "properties": { "activityTags": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": { "type": "string" } } ] }, "additionalTextAttributes": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "photos": { "type": "string" }, "duration": { "type": "string" }, "bestTimeToVisit": { "type": "string" }, "crowdLevels": { "type": "string" }, "gettingThere": { "type": "string" } }, "additionalProperties": false } }, { "type": "object", "properties": { "photos": { "type": "string" }, "duration": { "type": "string" }, "bestTimeToVisit": { "type": "string" }, "crowdLevels": { "type": "string" }, "gettingThere": { "type": "string" } }, "additionalProperties": false } ] }, "address": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "category": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "contentType": { "type": "string" }, "currencyCode": { "type": "string" }, "deliveryApps": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "type" ], "additionalProperties": false } }, "embeds": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "type": { "type": "string" }, "provider": { "type": "string" } }, "required": [ "code", "type", "provider" ], "additionalProperties": false } }, "featured": { "type": "boolean" }, "geoLocation": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "googleId": { "type": "string" }, "googleMapsUrl": { "type": "string" }, "googleRating": { "type": "number" }, "guideIds": { "type": "array", "items": { "type": "string" } }, "hostIds": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "integratedCategories": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "category_id": { "type": "string" }, "full_label": { "type": "array", "items": { "type": "string" } } }, "required": [ "category_id", "full_label" ], "additionalProperties": false } } }, { "type": "array", "items": { "type": "object", "properties": { "category_id": { "type": "string" }, "full_label": { "type": "array", "items": { "type": "string" } } }, "required": [ "category_id", "full_label" ], "additionalProperties": false } } ] }, "keywords": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": { "type": "string" } } ] }, "languageCodes": { "type": "array", "items": { "type": "string" } }, "name": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "neighborhood": { "type": "string" }, "openingHours": { "type": "object", "properties": { "isUnavailable": { "type": "boolean" }, "nextCloseTime": { "type": "string" }, "openNow": { "type": "boolean" }, "weekday_text": { "type": "array", "items": { "type": "string" } }, "periods": { "type": "array", "items": { "type": "object", "properties": { "open": { "type": "object", "properties": { "day": { "type": "number" }, "time": { "type": "string" }, "hours": { "type": "number" }, "minutes": { "type": "number" }, "hour": { "type": "number" }, "minute": { "type": "number" } }, "required": [ "day" ], "additionalProperties": false }, "close": { "type": "object", "properties": { "day": { "type": "number" }, "time": { "type": "string" }, "hours": { "type": "number" }, "minutes": { "type": "number" }, "hour": { "type": "number" }, "minute": { "type": "number" } }, "required": [ "day" ], "additionalProperties": false, "nullable": true } }, "required": [ "open" ], "additionalProperties": false } } }, "additionalProperties": false }, "phoneNumber": { "type": "string" }, "photos": { "type": "array", "items": { "type": "object", "properties": { "attributions": { "type": "array", "items": { "type": "string" } }, "category": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "object", "properties": { "size": { "type": "string" }, "url": { "type": "string" } }, "required": [ "size", "url" ], "additionalProperties": false } }, "keywords": { "type": "array", "items": { "type": "string" } }, "isGenerated": { "type": "boolean" }, "genDescription": { "type": "string" }, "license": { "type": "string" }, "isLicensed": { "type": "boolean" } }, "required": [ "attributions", "category", "id", "images", "keywords" ], "additionalProperties": false } }, "planVisit": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "preferences": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "timeOfDay": { "type": "array", "items": { "type": "string" } }, "timeOfYear": { "type": "array", "items": { "type": "string" } }, "tripType": { "type": "array", "items": { "type": "string" } }, "userCategories": { "type": "array", "items": { "type": "string" } }, "userInterests": { "type": "array", "items": { "type": "string" } }, "weatherType": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, { "type": "object", "properties": { "timeOfDay": { "type": "array", "items": { "type": "string" } }, "timeOfYear": { "type": "array", "items": { "type": "string" } }, "tripType": { "type": "array", "items": { "type": "string" } }, "userCategories": { "type": "array", "items": { "type": "string" } }, "userInterests": { "type": "array", "items": { "type": "string" } }, "weatherType": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "priceLevel": { "type": "number" }, "priceLevelText": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "priority": { "type": "number" }, "score": { "type": "number" }, "searchId": { "type": "string" }, "searchTerms": { "type": "array", "items": { "type": "string" } }, "serviceTypes": { "type": "array", "items": { "type": "string" } }, "socialMedia": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": "string" }, "target": { "type": "string" } }, "required": [ "name", "url", "icon" ], "additionalProperties": false } }, "status": { "type": "string" }, "summary": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "tableBooking": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "type" ], "additionalProperties": false, "nullable": true }, "tagline": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "tripAdvisorRating": { "type": "number" }, "tripAdvisorUrl": { "type": "string" }, "websiteUrl": { "type": "string", "nullable": true }, "whatToExpect": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "geoDistance": { "type": "number" }, "additionalData": { "anyOf": [ { "type": "object", "properties": { "dateTimestamp": { "type": "number" }, "date": { "type": "object", "properties": { "start_date": { "type": "string" }, "when": { "type": "string" } }, "required": [ "start_date", "when" ], "additionalProperties": false }, "venue": { "type": "object", "properties": { "link": { "type": "string" }, "name": { "type": "string" }, "reviews": { "type": "number" } }, "required": [ "link", "name", "reviews" ], "additionalProperties": false }, "ticket_info": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string" }, "link_type": { "type": "string" }, "source": { "type": "string" } }, "required": [ "link", "link_type", "source" ], "additionalProperties": false } } }, "required": [ "dateTimestamp", "date", "venue", "ticket_info" ], "additionalProperties": false }, { "type": "object", "properties": { "vendor": { "type": "object", "properties": { "vendorId": { "type": "number" }, "vendorName": { "type": "string" }, "vendorUniqueueId": { "type": "number" }, "vendorIcon": { "type": "string" } }, "required": [ "vendorId", "vendorName", "vendorUniqueueId" ], "additionalProperties": false } }, "required": [ "vendor" ], "additionalProperties": false } ] } }, "required": [ "address", "contentType", "featured", "geoLocation", "guideIds", "hostIds", "id", "name", "photos", "score", "searchId", "status", "summary" ], "additionalProperties": false } } }, "required": [ "contentType", "description", "featured", "geoLocation", "hostIds", "id", "keywords", "languageCodes", "listingIds", "name", "updatedAt" ], "additionalProperties": false } }, "total": { "type": "number" }, "pages": { "type": "number" } }, "required": [ "results", "total", "pages" ], "additionalProperties": false } } } }, "400": { "description": "No matches" } } } }, "/v2/orgs/{orgId}/listing-search": { "get": { "tags": [ "V2 Multilingual" ], "description": "Search for listings matching criteria. Returns matching listings with localized content.", "operationId": "v2SearchListings", "parameters": [ { "name": "orgId", "in": "path", "required": true, "description": "Organization Account Number", "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "required": false, "description": "Unique profile identifier", "schema": { "type": "string" } }, { "name": "userCategory", "in": "query", "required": false, "description": "Adding a user category will only return guides that match the category. Possible values: business, family, friends, solo, or couples", "schema": { "type": "string" } }, { "name": "tripType", "in": "query", "required": false, "description": "Adding a trip type will rank guides based on trip type suitability. Possible values: business, pleasure, or both. Default: both", "schema": { "type": "string" } }, { "name": "userInterests", "in": "query", "required": false, "description": "Comma-separated list of user interests to rank results by weighted match. Available values can be retrieved from the /getPersonalizationOptions endpoint.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Page index used to get next page of responses", "schema": { "type": "integer" } }, { "name": "hitsPerPage", "in": "query", "required": false, "description": "Hits per page, maximum 20", "schema": { "type": "integer" } }, { "name": "searchQuery", "in": "query", "required": false, "description": "A text query containing a name and optionally a location", "schema": { "type": "string" } }, { "name": "radius", "in": "query", "required": false, "description": "Radius in meters from center of search", "schema": { "type": "number" } }, { "name": "latlng", "in": "query", "required": false, "description": "Latitude and Longitude as the center of search, comma separated. Ex: 55.953251,-3.188267", "schema": { "type": "string" } }, { "name": "rankBy", "in": "query", "required": false, "description": "Ranking strategy. One of: 'distance', 'relevance', 'score'", "schema": { "type": "string" } }, { "name": "activityTags", "in": "query", "required": false, "description": "Comma-separated list of activity tags to filter listings", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "BCP-47 language code (e.g. en-GB). When provided, localizable fields are returned as a single string instead of a language map.", "schema": { "type": "string" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "activityTags": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": { "type": "string" } } ] }, "additionalTextAttributes": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "photos": { "type": "string" }, "duration": { "type": "string" }, "bestTimeToVisit": { "type": "string" }, "crowdLevels": { "type": "string" }, "gettingThere": { "type": "string" } }, "additionalProperties": false } }, { "type": "object", "properties": { "photos": { "type": "string" }, "duration": { "type": "string" }, "bestTimeToVisit": { "type": "string" }, "crowdLevels": { "type": "string" }, "gettingThere": { "type": "string" } }, "additionalProperties": false } ] }, "address": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "category": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "contentType": { "type": "string" }, "currencyCode": { "type": "string" }, "deliveryApps": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "type" ], "additionalProperties": false } }, "embeds": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "type": { "type": "string" }, "provider": { "type": "string" } }, "required": [ "code", "type", "provider" ], "additionalProperties": false } }, "featured": { "type": "boolean" }, "geoLocation": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "googleId": { "type": "string" }, "googleMapsUrl": { "type": "string" }, "googleRating": { "type": "number" }, "guideIds": { "type": "array", "items": { "type": "string" } }, "hostIds": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "integratedCategories": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "category_id": { "type": "string" }, "full_label": { "type": "array", "items": { "type": "string" } } }, "required": [ "category_id", "full_label" ], "additionalProperties": false } } }, { "type": "array", "items": { "type": "object", "properties": { "category_id": { "type": "string" }, "full_label": { "type": "array", "items": { "type": "string" } } }, "required": [ "category_id", "full_label" ], "additionalProperties": false } } ] }, "keywords": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": { "type": "string" } } ] }, "languageCodes": { "type": "array", "items": { "type": "string" } }, "name": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "neighborhood": { "type": "string" }, "openingHours": { "type": "object", "properties": { "isUnavailable": { "type": "boolean" }, "nextCloseTime": { "type": "string" }, "openNow": { "type": "boolean" }, "weekday_text": { "type": "array", "items": { "type": "string" } }, "periods": { "type": "array", "items": { "type": "object", "properties": { "open": { "type": "object", "properties": { "day": { "type": "number" }, "time": { "type": "string" }, "hours": { "type": "number" }, "minutes": { "type": "number" }, "hour": { "type": "number" }, "minute": { "type": "number" } }, "required": [ "day" ], "additionalProperties": false }, "close": { "type": "object", "properties": { "day": { "type": "number" }, "time": { "type": "string" }, "hours": { "type": "number" }, "minutes": { "type": "number" }, "hour": { "type": "number" }, "minute": { "type": "number" } }, "required": [ "day" ], "additionalProperties": false, "nullable": true } }, "required": [ "open" ], "additionalProperties": false } } }, "additionalProperties": false }, "phoneNumber": { "type": "string" }, "photos": { "type": "array", "items": { "type": "object", "properties": { "attributions": { "type": "array", "items": { "type": "string" } }, "category": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "object", "properties": { "size": { "type": "string" }, "url": { "type": "string" } }, "required": [ "size", "url" ], "additionalProperties": false } }, "keywords": { "type": "array", "items": { "type": "string" } }, "isGenerated": { "type": "boolean" }, "genDescription": { "type": "string" }, "license": { "type": "string" }, "isLicensed": { "type": "boolean" } }, "required": [ "attributions", "category", "id", "images", "keywords" ], "additionalProperties": false } }, "planVisit": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "preferences": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "timeOfDay": { "type": "array", "items": { "type": "string" } }, "timeOfYear": { "type": "array", "items": { "type": "string" } }, "tripType": { "type": "array", "items": { "type": "string" } }, "userCategories": { "type": "array", "items": { "type": "string" } }, "userInterests": { "type": "array", "items": { "type": "string" } }, "weatherType": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, { "type": "object", "properties": { "timeOfDay": { "type": "array", "items": { "type": "string" } }, "timeOfYear": { "type": "array", "items": { "type": "string" } }, "tripType": { "type": "array", "items": { "type": "string" } }, "userCategories": { "type": "array", "items": { "type": "string" } }, "userInterests": { "type": "array", "items": { "type": "string" } }, "weatherType": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "priceLevel": { "type": "number" }, "priceLevelText": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "priority": { "type": "number" }, "score": { "type": "number" }, "searchId": { "type": "string" }, "searchTerms": { "type": "array", "items": { "type": "string" } }, "serviceTypes": { "type": "array", "items": { "type": "string" } }, "socialMedia": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": "string" }, "target": { "type": "string" } }, "required": [ "name", "url", "icon" ], "additionalProperties": false } }, "status": { "type": "string" }, "summary": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "tableBooking": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "type" ], "additionalProperties": false, "nullable": true }, "tagline": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "tripAdvisorRating": { "type": "number" }, "tripAdvisorUrl": { "type": "string" }, "websiteUrl": { "type": "string", "nullable": true }, "whatToExpect": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "geoDistance": { "type": "number" }, "additionalData": { "anyOf": [ { "type": "object", "properties": { "dateTimestamp": { "type": "number" }, "date": { "type": "object", "properties": { "start_date": { "type": "string" }, "when": { "type": "string" } }, "required": [ "start_date", "when" ], "additionalProperties": false }, "venue": { "type": "object", "properties": { "link": { "type": "string" }, "name": { "type": "string" }, "reviews": { "type": "number" } }, "required": [ "link", "name", "reviews" ], "additionalProperties": false }, "ticket_info": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string" }, "link_type": { "type": "string" }, "source": { "type": "string" } }, "required": [ "link", "link_type", "source" ], "additionalProperties": false } } }, "required": [ "dateTimestamp", "date", "venue", "ticket_info" ], "additionalProperties": false }, { "type": "object", "properties": { "vendor": { "type": "object", "properties": { "vendorId": { "type": "number" }, "vendorName": { "type": "string" }, "vendorUniqueueId": { "type": "number" }, "vendorIcon": { "type": "string" } }, "required": [ "vendorId", "vendorName", "vendorUniqueueId" ], "additionalProperties": false } }, "required": [ "vendor" ], "additionalProperties": false } ] } }, "required": [ "address", "contentType", "featured", "geoLocation", "guideIds", "hostIds", "id", "name", "photos", "score", "searchId", "status", "summary" ], "additionalProperties": false } }, "total": { "type": "number" }, "pages": { "type": "number" } }, "required": [ "results", "total", "pages" ], "additionalProperties": false } } } }, "400": { "description": "No matches" } } } }, "/v2/orgs/{orgId}/location-search": { "get": { "tags": [ "V2 Multilingual" ], "description": "Search for locations matching criteria. Returns matching locations (neighbourhoods, districts, areas) with localized content.", "operationId": "v2SearchLocations", "parameters": [ { "name": "orgId", "in": "path", "required": true, "description": "Organization Account Number", "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "required": false, "description": "Unique profile identifier", "schema": { "type": "string" } }, { "name": "searchQuery", "in": "query", "required": false, "description": "A text query containing a name and optionally a location", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Page index used to get next page of responses", "schema": { "type": "integer" } }, { "name": "hitsPerPage", "in": "query", "required": false, "description": "Hits per page, maximum 20", "schema": { "type": "integer" } }, { "name": "latlng", "in": "query", "required": false, "description": "Latitude and Longitude as the center of search, comma separated. Ex: 55.953251,-3.188267", "schema": { "type": "string" } }, { "name": "radius", "in": "query", "required": false, "description": "Radius in meters from center of search", "schema": { "type": "number" } }, { "name": "rankBy", "in": "query", "required": false, "description": "Ranking strategy. One of: 'distance', 'relevance', 'score'", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "BCP-47 language code (e.g. en-GB). When provided, localizable fields are returned as a single string instead of a language map.", "schema": { "type": "string" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "hostIds": { "type": "array", "items": { "type": "string" } }, "address": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "displayName": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "area": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "headline": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "description": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "keywords": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": { "type": "string" } } ] }, "photos": { "type": "array", "items": { "type": "object", "properties": { "attributions": { "type": "array", "items": { "type": "string" } }, "category": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "object", "properties": { "size": { "type": "string" }, "url": { "type": "string" } }, "required": [ "size", "url" ], "additionalProperties": false } }, "keywords": { "type": "array", "items": { "type": "string" } }, "isGenerated": { "type": "boolean" }, "genDescription": { "type": "string" }, "license": { "type": "string" }, "isLicensed": { "type": "boolean" } }, "required": [ "attributions", "category", "id", "images", "keywords" ], "additionalProperties": false } }, "radius": { "type": "number" }, "status": { "type": "string" }, "languageCodes": { "type": "array", "items": { "type": "string" } }, "geoLocation": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "geoDistance": { "type": "number" } }, "required": [ "id", "hostIds", "status", "geoLocation" ], "additionalProperties": false } }, "total": { "type": "number" }, "pages": { "type": "number" } }, "required": [ "results", "total", "pages" ], "additionalProperties": false } } } }, "400": { "description": "No matches" } } } }, "/v2/orgs/{orgId}/host-profile": { "get": { "tags": [ "V2 Multilingual" ], "description": "Retrieve a host profile by ID. Returns the public-safe profile fields; internal fields such as API keys and analytics configuration are excluded.", "operationId": "v2GetHostProfile", "parameters": [ { "name": "orgId", "in": "path", "required": true, "description": "Organization Account Number", "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "required": true, "description": "Unique profile identifier", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "BCP-47 language code (e.g. en-GB). When provided, localizable fields are returned as a single string instead of a language map.", "schema": { "type": "string" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "orgId": { "type": "string" }, "geoLocation": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "primaryLocation": { "type": "object", "properties": { "displayName": { "type": "string" }, "address": { "type": "string" }, "locationId": { "type": "string" }, "measurement": { "type": "string" }, "geoLocation": { "type": "object", "properties": { "lat": { "type": "number" }, "lng": { "type": "number" } }, "required": [ "lat", "lng" ], "additionalProperties": false } }, "required": [ "displayName", "address", "locationId", "measurement" ], "additionalProperties": false }, "searchConfig": { "type": "object", "properties": { "searchRadius": { "type": "number" }, "guideRanking": { "type": "string" }, "listingRanking": { "type": "string" }, "maxSearchResults": { "type": "number" } }, "additionalProperties": false }, "languageCodes": { "type": "array", "items": { "type": "string" } }, "defaultLanguageCode": { "type": "string" }, "distanceMetric": { "type": "string", "enum": [ "imperial", "metric" ] }, "currencyCode": { "type": "string" }, "currencySymbol": { "type": "string" }, "timeZoneName": { "type": "string" }, "stage": { "type": "string" }, "analytics": { "type": "object", "properties": { "googleTagId": { "type": "string" }, "facebookPixelId": { "type": "string" } }, "required": [ "googleTagId", "facebookPixelId" ], "additionalProperties": false }, "feedback": { "type": "object", "properties": { "npsWatermark": { "type": "number" }, "csatLevels": { "type": "object", "properties": { "totalEvents": { "type": "number" }, "prsClicks": { "type": "number" }, "totalPlaceViews": { "type": "number" }, "totalPicklistViews": { "type": "number" }, "type": { "type": "string" }, "validTags": { "type": "array", "items": { "type": "string" } }, "askFeedback": { "type": "boolean" }, "minSessionDuration": { "type": "number" }, "minSessions": { "type": "number" } }, "required": [ "totalEvents", "prsClicks", "totalPlaceViews" ], "additionalProperties": false } }, "required": [ "npsWatermark", "csatLevels" ], "additionalProperties": false }, "integrations": { "type": "object", "properties": { "oracleOhip": { "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "hotelId": { "type": "string" }, "hostName": { "type": "string" } }, "required": [ "clientId", "clientSecret", "username", "password", "hotelId", "hostName" ], "additionalProperties": false }, "mews": { "type": "object", "properties": { "accessToken": { "type": "string" }, "clientToken": { "type": "string" }, "platformAddress": { "type": "string" } }, "required": [ "accessToken", "clientToken", "platformAddress" ], "additionalProperties": false } }, "additionalProperties": false }, "tsAPIKey": { "type": "object", "properties": { "id": { "type": "number" }, "value": { "type": "string" }, "createdAt": { "type": "number" }, "host": { "type": "string" } }, "required": [ "id", "value", "createdAt" ], "additionalProperties": false }, "uiConfig": { "type": "object", "properties": { "banner": { "type": "object", "properties": { "image": { "type": "object", "properties": { "url": { "type": "string" }, "path": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "classifications": { "type": "array", "items": { "type": "string" } }, "caption": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "path" ], "additionalProperties": false, "nullable": true }, "text": { "type": "string" }, "backgroundColor": { "type": "string" }, "textColor": { "type": "string" }, "LogoColor": { "type": "string", "enum": [ "dark", "light" ] }, "ctaLabel": { "type": "string" }, "ctaIconClass": { "type": "string" }, "showLogo": { "type": "boolean" }, "showLocation": { "type": "boolean" }, "showWeather": { "type": "boolean" } }, "required": [ "image", "text", "backgroundColor", "textColor", "LogoColor", "ctaLabel", "ctaIconClass", "showLogo", "showLocation", "showWeather" ], "additionalProperties": false }, "loadingBanner": { "type": "object", "properties": { "image": { "type": "object", "properties": { "url": { "type": "string" }, "path": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "classifications": { "type": "array", "items": { "type": "string" } }, "caption": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "path" ], "additionalProperties": false, "nullable": true }, "LogoColor": { "type": "string", "enum": [ "dark", "light" ] }, "backgroundColor": { "type": "string" }, "textColor": { "type": "string" } }, "required": [ "image", "LogoColor", "backgroundColor", "textColor" ], "additionalProperties": false }, "neighborhoods": { "type": "boolean" }, "prsModules": { "type": "array", "items": { "type": "string" } }, "preferredTravelMode": { "type": "string", "enum": [ "DRIVING", "WALKING", "BICYCLING", "TRANSIT" ] }, "contact": { "type": "object", "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "website": { "type": "string" } }, "required": [ "email", "phone", "website" ], "additionalProperties": false }, "customMapMarkerUrl": { "type": "string" }, "featured": { "type": "object", "properties": { "label": { "type": "string" }, "shortLabel": { "type": "string" }, "iconUrl": { "type": "string" }, "colors": { "type": "object", "properties": { "name": { "type": "string" }, "hex": { "type": "string" }, "darkContrast": { "type": "boolean" }, "hexContrast": { "type": "string" } }, "required": [ "name", "hex", "darkContrast", "hexContrast" ], "additionalProperties": false }, "cornerRadius": { "type": "object", "additionalProperties": { "type": "object", "properties": { "topLeft": { "type": "number" }, "topRight": { "type": "number" }, "bottomLeft": { "type": "number" }, "bottomRight": { "type": "number" } }, "required": [ "topLeft", "topRight", "bottomLeft", "bottomRight" ], "additionalProperties": false } } }, "required": [ "label", "shortLabel", "iconUrl", "colors", "cornerRadius" ], "additionalProperties": false } }, "required": [ "banner", "loadingBanner", "neighborhoods", "prsModules", "preferredTravelMode" ], "additionalProperties": false }, "branding": { "type": "object", "properties": { "theme": { "type": "object", "properties": { "colors": { "type": "object", "properties": { "primary": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary100": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary200": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary300": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary400": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary500": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary600": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary700": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary800": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary900": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary100": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary200": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary300": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary400": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary500": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary600": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary700": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary800": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary900": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "background": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "backgroundContrast": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "success": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "warning": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "error": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "highEmphasis": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "mediumEmphasis": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "disabled": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "onSurface": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "onSurfaceHighEmphasis": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "onSurfaceMediumEmphasis": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "onSurfaceDisabled": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false } }, "required": [ "primary", "primary100", "primary200", "primary300", "primary400", "primary500", "primary600", "primary700", "primary800", "primary900", "secondary100", "secondary200", "secondary300", "secondary400", "secondary500", "secondary600", "secondary700", "secondary800", "secondary900", "background", "backgroundContrast", "success", "warning", "error", "highEmphasis", "mediumEmphasis", "disabled", "onSurface", "onSurfaceHighEmphasis", "onSurfaceMediumEmphasis", "onSurfaceDisabled" ], "additionalProperties": false }, "fonts": { "type": "object", "properties": { "desktop": { "type": "object", "properties": { "header1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header3": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header4": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header5": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header6": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "subtitle1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "subtitle2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "body1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "body2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "caption": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "captionBold": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "overline": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "overlineBold": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false } }, "required": [ "header1", "header2", "header3", "header4", "header5", "header6", "subtitle1", "subtitle2", "body1", "body2", "button", "caption", "captionBold", "overline", "overlineBold" ], "additionalProperties": false }, "mobile": { "type": "object", "properties": { "header1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header3": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header4": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header5": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header6": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "subtitle1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "subtitle2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "body1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "body2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "caption": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "captionBold": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "overline": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "overlineBold": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false } }, "required": [ "header1", "header2", "header3", "header4", "header5", "header6", "subtitle1", "subtitle2", "body1", "body2", "button", "caption", "captionBold", "overline", "overlineBold" ], "additionalProperties": false }, "customFonts": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "name", "url" ], "additionalProperties": false } } }, "required": [ "desktop", "mobile" ], "additionalProperties": false } }, "required": [ "colors", "fonts" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "primary": { "type": "string" }, "background": { "type": "string" } }, "required": [ "primary", "background" ], "additionalProperties": false }, "fonts": { "type": "object", "properties": { "primary": { "type": "string" }, "secondary": { "type": "string" }, "letterSpacingHeaders": { "type": "number" }, "letterSpacingBody": { "type": "number" }, "lineHeightHeaders": { "type": "number" }, "lineHeightBody": { "type": "number" }, "fontSizeHeaders": { "type": "number" }, "fontSizeBody": { "type": "number" } }, "required": [ "primary", "secondary", "letterSpacingHeaders", "letterSpacingBody", "lineHeightHeaders", "lineHeightBody", "fontSizeHeaders", "fontSizeBody" ], "additionalProperties": false }, "logos": { "type": "object", "properties": { "dark": { "type": "string" }, "light": { "type": "string" }, "attrs": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" }, "bannerLogo": { "type": "string", "enum": [ "dark", "light" ] }, "loadingBannnerLogo": { "type": "string", "enum": [ "dark", "light" ] } }, "required": [ "bannerLogo", "loadingBannnerLogo" ], "additionalProperties": false } }, "required": [ "dark", "light", "attrs" ], "additionalProperties": false }, "customFont": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "name", "url" ], "additionalProperties": false }, "favicon": { "type": "string" } }, "required": [ "colors", "fonts" ], "additionalProperties": false }, "logos": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "file": { "type": "object", "properties": { "url": { "type": "string" }, "path": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "classifications": { "type": "array", "items": { "type": "string" } }, "caption": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "path" ], "additionalProperties": false }, "height": { "type": "number" }, "logoColor": { "type": "string", "enum": [ "dark", "light" ] }, "name": { "type": "string" }, "url": { "type": "string" }, "width": { "type": "number" } }, "required": [ "description", "file", "height", "logoColor", "name", "url", "width" ], "additionalProperties": false } }, "pages": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "path": { "type": "string" }, "icons": { "type": "object", "properties": { "active": { "type": "string" }, "inactive": { "type": "string" } }, "required": [ "active", "inactive" ], "additionalProperties": false } }, "required": [ "label", "type", "enabled", "path" ], "additionalProperties": false } }, "weather": { "type": "object", "properties": { "id": { "type": "number" }, "weatherLocation": { "type": "string" }, "temperature": { "type": "number" }, "tempMetric": { "type": "string" }, "icon": { "type": "string" } }, "additionalProperties": false }, "perks": { "type": "object", "properties": { "header": { "type": "string" }, "sections": { "type": "array", "items": { "type": "string" } } }, "required": [ "header", "sections" ], "additionalProperties": false }, "socialMedia": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": "string" }, "target": { "type": "string" } }, "required": [ "name", "url", "icon" ], "additionalProperties": false } }, "travellerArchetypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "travelPurpose": { "type": "array", "items": { "type": "string" } }, "activityTags": { "type": "array", "items": { "type": "string" } }, "archetypeTags": { "type": "array", "items": { "type": "string" } }, "codeNames": { "type": "array", "items": { "type": "string" } }, "travellerTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "travelPurpose", "activityTags", "archetypeTags", "codeNames", "travellerTypes" ], "additionalProperties": false } }, "redirectUrls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "url", "label", "type", "enabled" ], "additionalProperties": false } }, "linkTree": { "type": "object", "properties": { "sections": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "links": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": "string" }, "copyCaption": { "type": "boolean" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "trackingEventName": { "type": "string" } }, "required": [ "label", "url", "icon", "copyCaption" ], "additionalProperties": false } } }, "required": [ "title", "links" ], "additionalProperties": false } } }, "required": [ "sections" ], "additionalProperties": false }, "activeIntegrations": { "type": "array", "items": { "type": "string" } }, "embeddedConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "updatedBy": { "type": "string" }, "createdBy": { "type": "string" }, "customIconUrl": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "selectedLayout": { "type": "string", "enum": [ "Blog", "Explorer", "Playlist", "Default", "Modular" ] }, "kioskMode": { "type": "boolean" }, "disableJustForYou": { "type": "boolean" }, "disableAnimations": { "type": "boolean" }, "disableSavedListings": { "type": "boolean" }, "modules": { "type": "array", "items": { "type": "string", "enum": [ "Banner", "Grid", "List", "Map", "Menu", "ListMap", "FunctionalPanel" ] } }, "requirePreferences": { "type": "boolean" }, "preferredTravelMode": { "type": "string", "enum": [ "DRIVING", "WALKING", "BICYCLING", "TRANSIT" ] }, "menuOptions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Search", "Curated Guides", "All Guides", "Area Guides", "Just For You" ] }, "label": { "type": "string" }, "iconClass": { "type": "string" } }, "required": [ "name", "label", "iconClass" ], "additionalProperties": false } }, "containerOptions": { "type": "object", "properties": { "padding": { "type": "object", "properties": { "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "left": { "type": "number" } }, "additionalProperties": false }, "maxWidth": { "type": "number" }, "map": { "type": "object", "properties": { "width": { "type": "string" }, "height": { "type": "string" } }, "required": [ "width", "height" ], "additionalProperties": false } }, "additionalProperties": false }, "drawer": { "type": "boolean" }, "drawerDelayMs": { "type": "number" }, "gridRows": { "type": "number" }, "gridRowsMobile": { "type": "number" }, "hideTravel": { "type": "boolean" }, "hideGuideHeader": { "type": "boolean" }, "hideLanguageSelector": { "type": "boolean" }, "lang": { "type": "string" }, "cornerRadius": { "type": "object", "properties": { "card": { "type": "object", "properties": { "topLeft": { "type": "number" }, "topRight": { "type": "number" }, "bottomLeft": { "type": "number" }, "bottomRight": { "type": "number" } }, "required": [ "topLeft", "topRight", "bottomLeft", "bottomRight" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "topLeft": { "type": "number" }, "topRight": { "type": "number" }, "bottomLeft": { "type": "number" }, "bottomRight": { "type": "number" } }, "required": [ "topLeft", "topRight", "bottomLeft", "bottomRight" ], "additionalProperties": false } }, "required": [ "card", "button" ], "additionalProperties": false }, "experiments": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } } }, "required": [ "id", "createdAt", "name", "selectedLayout" ], "additionalProperties": false } } }, "required": [ "id", "name", "orgId" ], "additionalProperties": false } } } }, "400": { "description": "No matches" } } } }, "/v2/orgs/{orgId}/host-home": { "get": { "tags": [ "V2 Multilingual" ], "description": "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.", "operationId": "v2GetHostHome", "parameters": [ { "name": "orgId", "in": "path", "required": true, "description": "Organization Account Number", "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "required": true, "description": "Unique profile identifier", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "BCP-47 language code (e.g. en-GB). When provided, localizable fields are returned as a single string instead of a language map.", "schema": { "type": "string" } }, { "name": "latlng", "in": "query", "required": false, "description": "Latitude and Longitude as the center of search, comma separated. Ex: 55.953251,-3.188267", "schema": { "type": "string" } }, { "name": "radius", "in": "query", "required": false, "description": "Radius in meters from center of search", "schema": { "type": "number" } }, { "name": "userCategory", "in": "query", "required": false, "description": "Adding a user category will only return guides that match the category. Possible values: business, family, friends, solo, or couples", "schema": { "type": "string" } }, { "name": "tripType", "in": "query", "required": false, "description": "Adding a trip type will rank guides based on trip type suitability. Possible values: business, pleasure, or both. Default: both", "schema": { "type": "string" } }, { "name": "userInterests", "in": "query", "required": false, "description": "Comma-separated list of user interests to rank results by weighted match. Available values can be retrieved from the /getPersonalizationOptions endpoint.", "schema": { "type": "string" } }, { "name": "rankBy", "in": "query", "required": false, "description": "Ranking strategy. One of: 'distance', 'relevance', 'score'", "schema": { "type": "string" } }, { "name": "guideType", "in": "query", "required": false, "description": "Filter guides by type. 'featured' returns only featured guides; 'guide' and 'neighbourhood' return all guides (neighbourhoods are returned via the geoareas field).", "schema": { "type": "string", "enum": [ "guide", "neighbourhood", "featured" ] } }, { "name": "guidesPage", "in": "query", "required": false, "description": "Page index for guide results", "schema": { "type": "integer" } }, { "name": "guidesPerPage", "in": "query", "required": false, "description": "Number of guides per page, maximum 20", "schema": { "type": "integer" } }, { "name": "maxListingsPerGuide", "in": "query", "required": false, "description": "Maximum number of listings to include per guide", "schema": { "type": "integer" } }, { "name": "geoareasPage", "in": "query", "required": false, "description": "Page index for geo area results", "schema": { "type": "integer" } }, { "name": "geoareasPerPage", "in": "query", "required": false, "description": "Number of geo areas per page, maximum 20", "schema": { "type": "integer" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "host": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "orgId": { "type": "string" }, "geoLocation": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "primaryLocation": { "type": "object", "properties": { "displayName": { "type": "string" }, "address": { "type": "string" }, "locationId": { "type": "string" }, "measurement": { "type": "string" }, "geoLocation": { "type": "object", "properties": { "lat": { "type": "number" }, "lng": { "type": "number" } }, "required": [ "lat", "lng" ], "additionalProperties": false } }, "required": [ "displayName", "address", "locationId", "measurement" ], "additionalProperties": false }, "searchConfig": { "type": "object", "properties": { "searchRadius": { "type": "number" }, "guideRanking": { "type": "string" }, "listingRanking": { "type": "string" }, "maxSearchResults": { "type": "number" } }, "additionalProperties": false }, "languageCodes": { "type": "array", "items": { "type": "string" } }, "defaultLanguageCode": { "type": "string" }, "distanceMetric": { "type": "string", "enum": [ "imperial", "metric" ] }, "currencyCode": { "type": "string" }, "currencySymbol": { "type": "string" }, "timeZoneName": { "type": "string" }, "stage": { "type": "string" }, "analytics": { "type": "object", "properties": { "googleTagId": { "type": "string" }, "facebookPixelId": { "type": "string" } }, "required": [ "googleTagId", "facebookPixelId" ], "additionalProperties": false }, "feedback": { "type": "object", "properties": { "npsWatermark": { "type": "number" }, "csatLevels": { "type": "object", "properties": { "totalEvents": { "type": "number" }, "prsClicks": { "type": "number" }, "totalPlaceViews": { "type": "number" }, "totalPicklistViews": { "type": "number" }, "type": { "type": "string" }, "validTags": { "type": "array", "items": { "type": "string" } }, "askFeedback": { "type": "boolean" }, "minSessionDuration": { "type": "number" }, "minSessions": { "type": "number" } }, "required": [ "totalEvents", "prsClicks", "totalPlaceViews" ], "additionalProperties": false } }, "required": [ "npsWatermark", "csatLevels" ], "additionalProperties": false }, "integrations": { "type": "object", "properties": { "oracleOhip": { "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "hotelId": { "type": "string" }, "hostName": { "type": "string" } }, "required": [ "clientId", "clientSecret", "username", "password", "hotelId", "hostName" ], "additionalProperties": false }, "mews": { "type": "object", "properties": { "accessToken": { "type": "string" }, "clientToken": { "type": "string" }, "platformAddress": { "type": "string" } }, "required": [ "accessToken", "clientToken", "platformAddress" ], "additionalProperties": false } }, "additionalProperties": false }, "tsAPIKey": { "type": "object", "properties": { "id": { "type": "number" }, "value": { "type": "string" }, "createdAt": { "type": "number" }, "host": { "type": "string" } }, "required": [ "id", "value", "createdAt" ], "additionalProperties": false }, "uiConfig": { "type": "object", "properties": { "banner": { "type": "object", "properties": { "image": { "type": "object", "properties": { "url": { "type": "string" }, "path": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "classifications": { "type": "array", "items": { "type": "string" } }, "caption": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "path" ], "additionalProperties": false, "nullable": true }, "text": { "type": "string" }, "backgroundColor": { "type": "string" }, "textColor": { "type": "string" }, "LogoColor": { "type": "string", "enum": [ "dark", "light" ] }, "ctaLabel": { "type": "string" }, "ctaIconClass": { "type": "string" }, "showLogo": { "type": "boolean" }, "showLocation": { "type": "boolean" }, "showWeather": { "type": "boolean" } }, "required": [ "image", "text", "backgroundColor", "textColor", "LogoColor", "ctaLabel", "ctaIconClass", "showLogo", "showLocation", "showWeather" ], "additionalProperties": false }, "loadingBanner": { "type": "object", "properties": { "image": { "type": "object", "properties": { "url": { "type": "string" }, "path": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "classifications": { "type": "array", "items": { "type": "string" } }, "caption": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "path" ], "additionalProperties": false, "nullable": true }, "LogoColor": { "type": "string", "enum": [ "dark", "light" ] }, "backgroundColor": { "type": "string" }, "textColor": { "type": "string" } }, "required": [ "image", "LogoColor", "backgroundColor", "textColor" ], "additionalProperties": false }, "neighborhoods": { "type": "boolean" }, "prsModules": { "type": "array", "items": { "type": "string" } }, "preferredTravelMode": { "type": "string", "enum": [ "DRIVING", "WALKING", "BICYCLING", "TRANSIT" ] }, "contact": { "type": "object", "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "website": { "type": "string" } }, "required": [ "email", "phone", "website" ], "additionalProperties": false }, "customMapMarkerUrl": { "type": "string" }, "featured": { "type": "object", "properties": { "label": { "type": "string" }, "shortLabel": { "type": "string" }, "iconUrl": { "type": "string" }, "colors": { "type": "object", "properties": { "name": { "type": "string" }, "hex": { "type": "string" }, "darkContrast": { "type": "boolean" }, "hexContrast": { "type": "string" } }, "required": [ "name", "hex", "darkContrast", "hexContrast" ], "additionalProperties": false }, "cornerRadius": { "type": "object", "additionalProperties": { "type": "object", "properties": { "topLeft": { "type": "number" }, "topRight": { "type": "number" }, "bottomLeft": { "type": "number" }, "bottomRight": { "type": "number" } }, "required": [ "topLeft", "topRight", "bottomLeft", "bottomRight" ], "additionalProperties": false } } }, "required": [ "label", "shortLabel", "iconUrl", "colors", "cornerRadius" ], "additionalProperties": false } }, "required": [ "banner", "loadingBanner", "neighborhoods", "prsModules", "preferredTravelMode" ], "additionalProperties": false }, "branding": { "type": "object", "properties": { "theme": { "type": "object", "properties": { "colors": { "type": "object", "properties": { "primary": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary100": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary200": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary300": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary400": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary500": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary600": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary700": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary800": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "primary900": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary100": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary200": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary300": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary400": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary500": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary600": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary700": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary800": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "secondary900": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "background": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "backgroundContrast": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "success": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "warning": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "error": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "highEmphasis": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "mediumEmphasis": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "disabled": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "onSurface": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "onSurfaceHighEmphasis": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "onSurfaceMediumEmphasis": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false }, "onSurfaceDisabled": { "type": "object", "properties": { "textColor": { "type": "string" }, "backgroundColor": { "type": "string" } }, "required": [ "textColor", "backgroundColor" ], "additionalProperties": false } }, "required": [ "primary", "primary100", "primary200", "primary300", "primary400", "primary500", "primary600", "primary700", "primary800", "primary900", "secondary100", "secondary200", "secondary300", "secondary400", "secondary500", "secondary600", "secondary700", "secondary800", "secondary900", "background", "backgroundContrast", "success", "warning", "error", "highEmphasis", "mediumEmphasis", "disabled", "onSurface", "onSurfaceHighEmphasis", "onSurfaceMediumEmphasis", "onSurfaceDisabled" ], "additionalProperties": false }, "fonts": { "type": "object", "properties": { "desktop": { "type": "object", "properties": { "header1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header3": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header4": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header5": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header6": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "subtitle1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "subtitle2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "body1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "body2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "caption": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "captionBold": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "overline": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "overlineBold": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false } }, "required": [ "header1", "header2", "header3", "header4", "header5", "header6", "subtitle1", "subtitle2", "body1", "body2", "button", "caption", "captionBold", "overline", "overlineBold" ], "additionalProperties": false }, "mobile": { "type": "object", "properties": { "header1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header3": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header4": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header5": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "header6": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "subtitle1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "subtitle2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "body1": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "body2": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "caption": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "captionBold": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "overline": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false }, "overlineBold": { "type": "object", "properties": { "name": { "type": "string" }, "font": { "type": "string" }, "weight": { "type": "number" }, "size": { "type": "number" }, "lineHeight": { "type": "number" }, "letterSpacing": { "type": "number" } }, "required": [ "name", "font", "weight", "size", "lineHeight", "letterSpacing" ], "additionalProperties": false } }, "required": [ "header1", "header2", "header3", "header4", "header5", "header6", "subtitle1", "subtitle2", "body1", "body2", "button", "caption", "captionBold", "overline", "overlineBold" ], "additionalProperties": false }, "customFonts": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "name", "url" ], "additionalProperties": false } } }, "required": [ "desktop", "mobile" ], "additionalProperties": false } }, "required": [ "colors", "fonts" ], "additionalProperties": false }, "colors": { "type": "object", "properties": { "primary": { "type": "string" }, "background": { "type": "string" } }, "required": [ "primary", "background" ], "additionalProperties": false }, "fonts": { "type": "object", "properties": { "primary": { "type": "string" }, "secondary": { "type": "string" }, "letterSpacingHeaders": { "type": "number" }, "letterSpacingBody": { "type": "number" }, "lineHeightHeaders": { "type": "number" }, "lineHeightBody": { "type": "number" }, "fontSizeHeaders": { "type": "number" }, "fontSizeBody": { "type": "number" } }, "required": [ "primary", "secondary", "letterSpacingHeaders", "letterSpacingBody", "lineHeightHeaders", "lineHeightBody", "fontSizeHeaders", "fontSizeBody" ], "additionalProperties": false }, "logos": { "type": "object", "properties": { "dark": { "type": "string" }, "light": { "type": "string" }, "attrs": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" }, "bannerLogo": { "type": "string", "enum": [ "dark", "light" ] }, "loadingBannnerLogo": { "type": "string", "enum": [ "dark", "light" ] } }, "required": [ "bannerLogo", "loadingBannnerLogo" ], "additionalProperties": false } }, "required": [ "dark", "light", "attrs" ], "additionalProperties": false }, "customFont": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "name", "url" ], "additionalProperties": false }, "favicon": { "type": "string" } }, "required": [ "colors", "fonts" ], "additionalProperties": false }, "logos": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "file": { "type": "object", "properties": { "url": { "type": "string" }, "path": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "classifications": { "type": "array", "items": { "type": "string" } }, "caption": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "path" ], "additionalProperties": false }, "height": { "type": "number" }, "logoColor": { "type": "string", "enum": [ "dark", "light" ] }, "name": { "type": "string" }, "url": { "type": "string" }, "width": { "type": "number" } }, "required": [ "description", "file", "height", "logoColor", "name", "url", "width" ], "additionalProperties": false } }, "pages": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "path": { "type": "string" }, "icons": { "type": "object", "properties": { "active": { "type": "string" }, "inactive": { "type": "string" } }, "required": [ "active", "inactive" ], "additionalProperties": false } }, "required": [ "label", "type", "enabled", "path" ], "additionalProperties": false } }, "weather": { "type": "object", "properties": { "id": { "type": "number" }, "weatherLocation": { "type": "string" }, "temperature": { "type": "number" }, "tempMetric": { "type": "string" }, "icon": { "type": "string" } }, "additionalProperties": false }, "perks": { "type": "object", "properties": { "header": { "type": "string" }, "sections": { "type": "array", "items": { "type": "string" } } }, "required": [ "header", "sections" ], "additionalProperties": false }, "socialMedia": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": "string" }, "target": { "type": "string" } }, "required": [ "name", "url", "icon" ], "additionalProperties": false } }, "travellerArchetypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "travelPurpose": { "type": "array", "items": { "type": "string" } }, "activityTags": { "type": "array", "items": { "type": "string" } }, "archetypeTags": { "type": "array", "items": { "type": "string" } }, "codeNames": { "type": "array", "items": { "type": "string" } }, "travellerTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "travelPurpose", "activityTags", "archetypeTags", "codeNames", "travellerTypes" ], "additionalProperties": false } }, "redirectUrls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "url", "label", "type", "enabled" ], "additionalProperties": false } }, "linkTree": { "type": "object", "properties": { "sections": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "links": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": "string" }, "copyCaption": { "type": "boolean" }, "type": { "type": "string" }, "enabled": { "type": "boolean" }, "trackingEventName": { "type": "string" } }, "required": [ "label", "url", "icon", "copyCaption" ], "additionalProperties": false } } }, "required": [ "title", "links" ], "additionalProperties": false } } }, "required": [ "sections" ], "additionalProperties": false }, "activeIntegrations": { "type": "array", "items": { "type": "string" } }, "embeddedConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "updatedBy": { "type": "string" }, "createdBy": { "type": "string" }, "customIconUrl": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "selectedLayout": { "type": "string", "enum": [ "Blog", "Explorer", "Playlist", "Default", "Modular" ] }, "kioskMode": { "type": "boolean" }, "disableJustForYou": { "type": "boolean" }, "disableAnimations": { "type": "boolean" }, "disableSavedListings": { "type": "boolean" }, "modules": { "type": "array", "items": { "type": "string", "enum": [ "Banner", "Grid", "List", "Map", "Menu", "ListMap", "FunctionalPanel" ] } }, "requirePreferences": { "type": "boolean" }, "preferredTravelMode": { "type": "string", "enum": [ "DRIVING", "WALKING", "BICYCLING", "TRANSIT" ] }, "menuOptions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Search", "Curated Guides", "All Guides", "Area Guides", "Just For You" ] }, "label": { "type": "string" }, "iconClass": { "type": "string" } }, "required": [ "name", "label", "iconClass" ], "additionalProperties": false } }, "containerOptions": { "type": "object", "properties": { "padding": { "type": "object", "properties": { "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "left": { "type": "number" } }, "additionalProperties": false }, "maxWidth": { "type": "number" }, "map": { "type": "object", "properties": { "width": { "type": "string" }, "height": { "type": "string" } }, "required": [ "width", "height" ], "additionalProperties": false } }, "additionalProperties": false }, "drawer": { "type": "boolean" }, "drawerDelayMs": { "type": "number" }, "gridRows": { "type": "number" }, "gridRowsMobile": { "type": "number" }, "hideTravel": { "type": "boolean" }, "hideGuideHeader": { "type": "boolean" }, "hideLanguageSelector": { "type": "boolean" }, "lang": { "type": "string" }, "cornerRadius": { "type": "object", "properties": { "card": { "type": "object", "properties": { "topLeft": { "type": "number" }, "topRight": { "type": "number" }, "bottomLeft": { "type": "number" }, "bottomRight": { "type": "number" } }, "required": [ "topLeft", "topRight", "bottomLeft", "bottomRight" ], "additionalProperties": false }, "button": { "type": "object", "properties": { "topLeft": { "type": "number" }, "topRight": { "type": "number" }, "bottomLeft": { "type": "number" }, "bottomRight": { "type": "number" } }, "required": [ "topLeft", "topRight", "bottomLeft", "bottomRight" ], "additionalProperties": false } }, "required": [ "card", "button" ], "additionalProperties": false }, "experiments": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } } }, "required": [ "id", "createdAt", "name", "selectedLayout" ], "additionalProperties": false } } }, "required": [ "id", "name", "orgId" ], "additionalProperties": false }, "guides": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "attribution": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "centerLocation": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "contentType": { "type": "string" }, "coverImage": { "type": "object", "properties": { "attributions": { "type": "array", "items": { "type": "string" } }, "category": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "object", "properties": { "size": { "type": "string" }, "url": { "type": "string" } }, "required": [ "size", "url" ], "additionalProperties": false } }, "keywords": { "type": "array", "items": { "type": "string" } }, "isGenerated": { "type": "boolean" }, "genDescription": { "type": "string" }, "license": { "type": "string" }, "isLicensed": { "type": "boolean" } }, "required": [ "attributions", "category", "id", "images", "keywords" ], "additionalProperties": false }, "description": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "featured": { "default": false, "type": "boolean" }, "geoLocation": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "hostIds": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "introText": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "keywords": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": { "type": "string" } } ] }, "languageCodes": { "type": "array", "items": { "type": "string" } }, "listingIds": { "type": "array", "items": { "type": "string" } }, "name": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "preferences": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "timeOfDay": { "type": "array", "items": { "type": "string" } }, "timeOfYear": { "type": "array", "items": { "type": "string" } }, "tripType": { "type": "array", "items": { "type": "string" } }, "userCategories": { "type": "array", "items": { "type": "string" } }, "userInterests": { "type": "array", "items": { "type": "string" } }, "weatherType": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, { "type": "object", "properties": { "timeOfDay": { "type": "array", "items": { "type": "string" } }, "timeOfYear": { "type": "array", "items": { "type": "string" } }, "tripType": { "type": "array", "items": { "type": "string" } }, "userCategories": { "type": "array", "items": { "type": "string" } }, "userInterests": { "type": "array", "items": { "type": "string" } }, "weatherType": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "priority": { "type": "number", "minimum": 0 }, "status": { "type": "string" }, "updatedAt": { "type": "number" }, "geoDistance": { "type": "number" }, "listings": { "type": "array", "items": { "type": "object", "properties": { "activityTags": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": { "type": "string" } } ] }, "additionalTextAttributes": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "photos": { "type": "string" }, "duration": { "type": "string" }, "bestTimeToVisit": { "type": "string" }, "crowdLevels": { "type": "string" }, "gettingThere": { "type": "string" } }, "additionalProperties": false } }, { "type": "object", "properties": { "photos": { "type": "string" }, "duration": { "type": "string" }, "bestTimeToVisit": { "type": "string" }, "crowdLevels": { "type": "string" }, "gettingThere": { "type": "string" } }, "additionalProperties": false } ] }, "address": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "category": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "contentType": { "type": "string" }, "currencyCode": { "type": "string" }, "deliveryApps": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "type" ], "additionalProperties": false } }, "embeds": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "type": { "type": "string" }, "provider": { "type": "string" } }, "required": [ "code", "type", "provider" ], "additionalProperties": false } }, "featured": { "type": "boolean" }, "geoLocation": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "googleId": { "type": "string" }, "googleMapsUrl": { "type": "string" }, "googleRating": { "type": "number" }, "guideIds": { "type": "array", "items": { "type": "string" } }, "hostIds": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "integratedCategories": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "category_id": { "type": "string" }, "full_label": { "type": "array", "items": { "type": "string" } } }, "required": [ "category_id", "full_label" ], "additionalProperties": false } } }, { "type": "array", "items": { "type": "object", "properties": { "category_id": { "type": "string" }, "full_label": { "type": "array", "items": { "type": "string" } } }, "required": [ "category_id", "full_label" ], "additionalProperties": false } } ] }, "keywords": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": { "type": "string" } } ] }, "languageCodes": { "type": "array", "items": { "type": "string" } }, "name": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "neighborhood": { "type": "string" }, "openingHours": { "type": "object", "properties": { "isUnavailable": { "type": "boolean" }, "nextCloseTime": { "type": "string" }, "openNow": { "type": "boolean" }, "weekday_text": { "type": "array", "items": { "type": "string" } }, "periods": { "type": "array", "items": { "type": "object", "properties": { "open": { "type": "object", "properties": { "day": { "type": "number" }, "time": { "type": "string" }, "hours": { "type": "number" }, "minutes": { "type": "number" }, "hour": { "type": "number" }, "minute": { "type": "number" } }, "required": [ "day" ], "additionalProperties": false }, "close": { "type": "object", "properties": { "day": { "type": "number" }, "time": { "type": "string" }, "hours": { "type": "number" }, "minutes": { "type": "number" }, "hour": { "type": "number" }, "minute": { "type": "number" } }, "required": [ "day" ], "additionalProperties": false, "nullable": true } }, "required": [ "open" ], "additionalProperties": false } } }, "additionalProperties": false }, "phoneNumber": { "type": "string" }, "photos": { "type": "array", "items": { "type": "object", "properties": { "attributions": { "type": "array", "items": { "type": "string" } }, "category": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "object", "properties": { "size": { "type": "string" }, "url": { "type": "string" } }, "required": [ "size", "url" ], "additionalProperties": false } }, "keywords": { "type": "array", "items": { "type": "string" } }, "isGenerated": { "type": "boolean" }, "genDescription": { "type": "string" }, "license": { "type": "string" }, "isLicensed": { "type": "boolean" } }, "required": [ "attributions", "category", "id", "images", "keywords" ], "additionalProperties": false } }, "planVisit": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "preferences": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "timeOfDay": { "type": "array", "items": { "type": "string" } }, "timeOfYear": { "type": "array", "items": { "type": "string" } }, "tripType": { "type": "array", "items": { "type": "string" } }, "userCategories": { "type": "array", "items": { "type": "string" } }, "userInterests": { "type": "array", "items": { "type": "string" } }, "weatherType": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, { "type": "object", "properties": { "timeOfDay": { "type": "array", "items": { "type": "string" } }, "timeOfYear": { "type": "array", "items": { "type": "string" } }, "tripType": { "type": "array", "items": { "type": "string" } }, "userCategories": { "type": "array", "items": { "type": "string" } }, "userInterests": { "type": "array", "items": { "type": "string" } }, "weatherType": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "priceLevel": { "type": "number" }, "priceLevelText": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "priority": { "type": "number" }, "score": { "type": "number" }, "searchId": { "type": "string" }, "searchTerms": { "type": "array", "items": { "type": "string" } }, "serviceTypes": { "type": "array", "items": { "type": "string" } }, "socialMedia": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": "string" }, "target": { "type": "string" } }, "required": [ "name", "url", "icon" ], "additionalProperties": false } }, "status": { "type": "string" }, "summary": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "tableBooking": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "url", "type" ], "additionalProperties": false, "nullable": true }, "tagline": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "tripAdvisorRating": { "type": "number" }, "tripAdvisorUrl": { "type": "string" }, "websiteUrl": { "type": "string", "nullable": true }, "whatToExpect": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "geoDistance": { "type": "number" }, "additionalData": { "anyOf": [ { "type": "object", "properties": { "dateTimestamp": { "type": "number" }, "date": { "type": "object", "properties": { "start_date": { "type": "string" }, "when": { "type": "string" } }, "required": [ "start_date", "when" ], "additionalProperties": false }, "venue": { "type": "object", "properties": { "link": { "type": "string" }, "name": { "type": "string" }, "reviews": { "type": "number" } }, "required": [ "link", "name", "reviews" ], "additionalProperties": false }, "ticket_info": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string" }, "link_type": { "type": "string" }, "source": { "type": "string" } }, "required": [ "link", "link_type", "source" ], "additionalProperties": false } } }, "required": [ "dateTimestamp", "date", "venue", "ticket_info" ], "additionalProperties": false }, { "type": "object", "properties": { "vendor": { "type": "object", "properties": { "vendorId": { "type": "number" }, "vendorName": { "type": "string" }, "vendorUniqueueId": { "type": "number" }, "vendorIcon": { "type": "string" } }, "required": [ "vendorId", "vendorName", "vendorUniqueueId" ], "additionalProperties": false } }, "required": [ "vendor" ], "additionalProperties": false } ] } }, "required": [ "address", "contentType", "featured", "geoLocation", "guideIds", "hostIds", "id", "name", "photos", "score", "searchId", "status", "summary" ], "additionalProperties": false } } }, "required": [ "contentType", "description", "featured", "geoLocation", "hostIds", "id", "keywords", "languageCodes", "listingIds", "name", "updatedAt" ], "additionalProperties": false } }, "total": { "type": "number" }, "pages": { "type": "number" } }, "required": [ "results", "total", "pages" ], "additionalProperties": false }, "geoareas": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "hostIds": { "type": "array", "items": { "type": "string" } }, "address": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "displayName": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "area": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "headline": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "description": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "string" } ] }, "keywords": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": { "type": "string" } } ] }, "photos": { "type": "array", "items": { "type": "object", "properties": { "attributions": { "type": "array", "items": { "type": "string" } }, "category": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "object", "properties": { "size": { "type": "string" }, "url": { "type": "string" } }, "required": [ "size", "url" ], "additionalProperties": false } }, "keywords": { "type": "array", "items": { "type": "string" } }, "isGenerated": { "type": "boolean" }, "genDescription": { "type": "string" }, "license": { "type": "string" }, "isLicensed": { "type": "boolean" } }, "required": [ "attributions", "category", "id", "images", "keywords" ], "additionalProperties": false } }, "radius": { "type": "number" }, "status": { "type": "string" }, "languageCodes": { "type": "array", "items": { "type": "string" } }, "geoLocation": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "geoDistance": { "type": "number" } }, "required": [ "id", "hostIds", "status", "geoLocation" ], "additionalProperties": false } }, "total": { "type": "number" }, "pages": { "type": "number" } }, "required": [ "results", "total", "pages" ], "additionalProperties": false } }, "required": [ "host", "guides", "geoareas" ], "additionalProperties": false } } } }, "400": { "description": "No matches" } } } }, "/v2/orgs/{orgId}/org-languages": { "get": { "tags": [ "V2 Multilingual" ], "description": "Returns the list of languages supported by the organization. When translationEnabled is false, only the default language is returned.", "operationId": "v2GetOrgLanguages", "parameters": [ { "name": "orgId", "in": "path", "required": true, "description": "Organization Account Number", "schema": { "type": "string" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "translationEnabled": { "type": "boolean" }, "defaultLanguage": { "type": "object", "properties": { "languageCode": { "type": "string" }, "languageName": { "type": "string" }, "dialect": { "type": "string" }, "nativeName": { "type": "string" }, "isDefault": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "flagIconUrl": { "type": "string" }, "rtl": { "type": "boolean" }, "currencyCode": { "type": "string" }, "currencySymbol": { "type": "string" }, "hour12": { "type": "boolean" }, "measurement": { "type": "string" }, "temperatureMetric": { "type": "string" }, "isLatinAlphabet": { "type": "boolean" } }, "required": [ "languageCode", "languageName", "dialect", "nativeName", "isDefault", "isEnabled", "flagIconUrl", "currencyCode", "currencySymbol", "hour12", "measurement", "temperatureMetric", "isLatinAlphabet" ], "additionalProperties": false }, "languages": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string" }, "languageName": { "type": "string" }, "dialect": { "type": "string" }, "nativeName": { "type": "string" }, "isDefault": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "flagIconUrl": { "type": "string" }, "rtl": { "type": "boolean" }, "currencyCode": { "type": "string" }, "currencySymbol": { "type": "string" }, "hour12": { "type": "boolean" }, "measurement": { "type": "string" }, "temperatureMetric": { "type": "string" }, "isLatinAlphabet": { "type": "boolean" } }, "required": [ "languageCode", "languageName", "dialect", "nativeName", "isDefault", "isEnabled", "flagIconUrl", "currencyCode", "currencySymbol", "hour12", "measurement", "temperatureMetric", "isLatinAlphabet" ], "additionalProperties": false } } }, "required": [ "translationEnabled", "defaultLanguage", "languages" ], "additionalProperties": false } } } }, "400": { "description": "No matches" } } } }, "/v2/orgs/{orgId}/sites/{siteId}/page-slug": { "get": { "tags": [ "V2 Site Data" ], "description": "Resolve complete persisted page slugs for a site. Without filters, returns a full tree. With destinationId, guideId, or locationId filters, returns matching page slug entries.", "operationId": "v2GetSitePageSlug", "parameters": [ { "name": "orgId", "in": "path", "required": true, "description": "Organization Account Number", "schema": { "type": "string" } }, { "name": "siteId", "in": "path", "required": true, "description": "Site identifier used to scope page slug resolution", "schema": { "type": "string" } }, { "name": "destinationId", "in": "query", "required": false, "description": "Destination identifier used to resolve destination/root and destination-scoped page slugs", "schema": { "type": "string" } }, { "name": "guideId", "in": "query", "required": false, "description": "Guide identifier used to fetch listings for a specific guide", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "required": false, "description": "Location identifier used to resolve area page slugs", "schema": { "type": "string" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SitePageSlugMatchesResponse" }, { "$ref": "#/components/schemas/SitePageSlugTreeResponse" } ] } } } }, "400": { "description": "No matches" } } } } } }