By URL name
const url = 'https://api.wink.travel/api/public/configuration/url-name/';const options = { method: 'GET', headers: {'Wink-Version': '2.0', Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.wink.travel/api/public/configuration/url-name/ \ --header 'Authorization: Bearer <token>' \ --header 'Wink-Version: 2.0'Resolves the affiliate’s client configuration using the company’s URL slug.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The urlName
Query Parameters
Section titled “Query Parameters”Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”OK
Resolved booking engine customization configuration exposed to client-side web components; merges affiliate overrides onto the base configuration
object
Managing entity identifier of affiliate
Whether to append text to the existing booking customization page title.
Choose how you large you want our web component cards to be.
Control which currency your users see prices in initially.
Control which language your users see text in initially.
Set a fixed itinerary end date ONLY populate this field if you want to fix the itinerary date. Also, leave numberOfAdvanceDays and numberOfStayDays empty.
Custom font for the booking engine. Null means use the system default.
All standalone GA4 Measurement IDs to configure client-side via gtag for this page (page owner + affiliate), deduped. Container-embedded GA4 is configured by its own container, not listed here.
If you want your users to see Google Maps in your hosted booking customization, go to Google Maps and create an API key for your site.
All GTM Container IDs to inject client-side for this page (page owner + affiliate), deduped. The browser injects each one sharing a single dataLayer.
If you are self-hosting our booking customization, let us know where it is hosted. Note: This url needs to be secured with SSL.
Unique customization configuration identifier
Choose how you want our web component cards laid out.
Customize booking confirmation emails by adding a custom logo to your configuration.
Engine configuration name
You can control the initial itinerary date used to retrieve travel inventory prices. You can do it in one of two ways: 1. Dynamically set the date by indicating how long and how many days in advance (this field), of today’s date, you want to display prices for. 2. Set a fixed date to display prices for. Option 1 is the most shared. Option 2 is for when you want to create a new customization and apply it to a specific event that occurs on a specific date. If you don’t use either of these options, the itinerary will default to today’s date with one night stay. ONLY populate this field if you want to control the itinerary date. Also, leave startDate and endDate empty.
You can control the initial itinerary date used to retrieve travel inventory prices. You can do it in one of two ways: 1. Dynamically set the date by indicating how long (this field) and how many days in advance, of today’s date, you want to display prices for. 2. Set a fixed date to display prices for. Option 1 is the most shared. Option 2 is for when you want to create a new customization and apply it to a specific event that occurs on a specific date. If you don’t use either of these options, the itinerary will default to today’s date with one night stay. ONLY populate this field if you want to control the itinerary date. Also, leave startDate and endDate empty.
Managing entity identifier
Managing entity name.
If you’ve received special promotional codes from suppliers to give to your audience, you can choose to bake these code directly into the price by entering them here.
Control how many adults / children will be staying and how many of that room to book. Defaults to: One room, two adults.
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Count of children of this age group in the room
Number of identical rooms with this configuration
Flag to indicate you are self-hosting our booking customization and not using our default booking customization url.
Whether to display rankings (lifestyle, eco score and reviews) on hotel landing page.
This feature flag controls whether to let a user move away from the hotel landing page using search.
Show unavailable inventory card when inventory not currently for sale. Otherwise, it displays a normal card but without the price.
Set a fixed itinerary start date. ONLY populate this field if you want to fix the itinerary date. Also, leave numberOfAdvanceDays and numberOfStayDays empty.
Sales channel sub-type.
Choose how you want our web components to look and more closely match with your own site style.
object
Body color
Danger color
Dark color
Info color
Light color
Muted color
Primary color
Secondary color
Success color
Warning color
White color
Tracking pixels to fire on key booking events.
Tracking pixel or web beacon configuration that fires on specified booking events for analytics and conversion tracking
object
Optional access token for providers that require authentication
Consent category for GDPR/CCPA compliance
Custom image URL for IMAGE type pixels. Will be loaded as a 1x1 tracking pixel.
Custom JavaScript code for CUSTOM provider type. Will be injected into the page.
Whether this tracking pixel is currently active
Unique identifier for this tracking pixel
User-friendly name for this tracking pixel
Page types where this pixel should fire. Empty list or containing ALL means fire on all pages.
Provider-specific pixel ID (e.g., Facebook Pixel ID, Google Ads Conversion ID)
Tracking pixel provider
Event triggers that cause this pixel to fire, with optional custom parameters.
Defines a booking funnel event that causes a tracking pixel to fire, together with optional custom key-value parameters sent with the event
object
The event type that triggers this pixel
Custom key-value parameters to include with the event
Key-value parameter passed with a tracking pixel event; values may be static strings or runtime placeholders such as {booking.total}
object
Parameter name (e.g., ‘currency’, ‘value’, ‘content_id’)
Parameter value. Can be a static value or a placeholder like ‘{booking.total}’
Type of tracking pixel delivery mechanism
If true, we use numberOfAdvanceDays / numberOfStayDays properties - false, we use startDate / endDate
Action to complete once a user clicks on the CTA button on inventory.
Example
{ "affiliateOwnerIdentifier": "2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72", "appendToPageTitle": "Hotels with Benefits", "cardLayout": "VERTICAL", "defaultCurrency": "THB", "defaultLanguage": "en", "endDate": "2026-07-22", "fontId": "PLAYFAIR_DISPLAY", "googleAnalyticsMeasurementIds": [ "G-ABCDEF1234" ], "googleMapsAPIKey": "AIzaSyC5H2f7Vf6-6b2dZWfZf6-6b2dZWfZf6-6", "googleTagManagerContainerIds": [ "GTM-XXXXX" ], "hostedBookingEngineUrl": "https://book.thesiamresidences.com/reservations", "identifier": "a4f2e8b1-7c5d-4b9a-9e3f-1d6c2a8f5e91", "layout": "INFORMATIONAL", "logoImageIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "name": "Luxury Travel Portal", "numberOfAdvanceDays": 7, "numberOfStayDays": 3, "ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName": "The Siam Residences", "promotionalCodes": [ "EARLY20", "LOYALTY10" ], "roomConfiguration": { "adults": 2, "children": [], "quantity": 1 }, "selfHosted": true, "showRankings": true, "showSearch": true, "showUnavailableCard": false, "startDate": "2026-07-15", "subType": "APPLICATION", "themeColors": { "danger": "#dc3545", "dark": "#343a40", "info": "#17a2b8", "light": "#f8f9fa", "primary": "#1a472a", "secondary": "#c9a961", "success": "#28a745", "warning": "#ffc107" }, "trackingPixels": [ { "consentCategory": "MARKETING", "enabled": true, "identifier": "f8e4b2c9-3a7d-4c1f-9e5b-2d6f1a8c4e73", "name": "Facebook Conversion Pixel", "pixelId": "1234567890", "provider": "FACEBOOK", "type": "JAVASCRIPT" } ], "useDays": true, "wcBookClickAction": "IBE_MODAL"}Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable