Grid by saved search
const url = 'https://api.wink.travel/api/public/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/inventory/search/list/dynamic-list-1?customizationIdentifier=2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"page":0,"size":10,"userSession":{"currency":"USD","itinerary":{"children":4,"endDate":"2026-07-18","guests":4,"hours":72,"items":[{"adults":2,"children":[{"age":7,"quantity":2}],"quantity":2}],"nights":3,"room":{"adults":2,"children":[{"age":7,"quantity":2}],"quantity":2},"rooms":2,"startDate":"2026-07-15"},"language":"en","lifestyle":"LIFESTYLE_RELAX","promotionalCodes":["SUMMER2026"],"selectedRoomConfigurationIndex":0}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'https://api.wink.travel/api/public/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/inventory/search/list/dynamic-list-1?customizationIdentifier=2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "page": 0, "size": 10, "userSession": { "currency": "USD", "itinerary": { "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15" }, "language": "en", "lifestyle": "LIFESTYLE_RELAX", "promotionalCodes": [ "SUMMER2026" ], "selectedRoomConfigurationIndex": 0 } }'Returns a page of properties matching a saved search (dynamic list) that belongs to this managing entity, as grid items, with the list itself. A list belonging to anyone else is not found. Replaces the deprecated POST search/list/{dynamicListIdentifier}; the request is the same, the answer is a grid response with prices in the property’s currency and FX quotes.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Managing entity identifier
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Saved search (dynamic list) identifier
Example
dynamic-list-1Query Parameters
Section titled “Query Parameters”Booking engine customization identifier; when omitted the managing entity’s default configuration is used
Example
2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”The user session and the page to return
Paged search request carrying the user session
object
The page to paginate to. Note: Page uses a 0-based index.
Example
0The result size to return.
Example
10User session is the current search state. SimpleDateTimeItinerary and other data points are all included here.
object
User’s currency preference (ISO 4217 code)
Example
USDDates and travel info.
object
Total number of children across all rooms
Example
4Check-out date (alternative to nights; nights takes precedence if both provided)
Example
2026-07-18Total number of adult guests across all rooms
Example
4Duration in hours (rounded up) between check-in and check-out. Used for hourly bookings; e.g., meeting rooms or day-use venues.
Example
72DEPRECATED pre-collapse room list, accepted for backwards compatibility and never returned. Send room instead. Only the first entry is used and any others are ignored: this API searches one room configuration per request. Use room.quantity to book several identical rooms.
Room occupancy and guest composition for a single or multiple identical rooms
object
Number of adult guests in this room type
Example
2Child 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)
Example
7Count of children of this age group in the room
Example
2Example
{ "age": 7, "quantity": 2}Number of identical rooms with this configuration
Example
2Example
{ "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2}Number of nights for the stay (alternative to endDate; takes precedence if both provided)
Example
3The room configuration being booked, and how many identical rooms of it
object
Number of adult guests in this room type
Example
2Child 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)
Example
7Count of children of this age group in the room
Example
2Example
{ "age": 7, "quantity": 2}Number of identical rooms with this configuration
Example
2Example
{ "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2}Total number of rooms in this itinerary
Example
2Check-in date (must be today or in the future)
Example
2026-07-15Example
{ "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15"}User’s language preference (ISO 639-1 code)
Example
enPreferred lifestyle category to filter accommodations
Example
LIFESTYLE_RELAXIndex of the currently selected room configuration for rate retrieval
Example
0Example
{ "currency": "USD", "itinerary": { "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15" }, "language": "en", "lifestyle": "LIFESTYLE_RELAX", "promotionalCodes": [ "SUMMER2026" ], "selectedRoomConfigurationIndex": 0}Example
{ "page": 0, "size": 10, "userSession": { "currency": "USD", "itinerary": { "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15" }, "language": "en", "lifestyle": "LIFESTYLE_RELAX", "promotionalCodes": [ "SUMMER2026" ], "selectedRoomConfigurationIndex": 0 }}Responses
Section titled “Responses”OK
A page of inventory grid items and the list they were resolved from.
object
Lightweight projection of a transactional list used in listings and event payloads, containing all display and configuration fields without audit metadata
object
Generate an animated GIF from multiple images instead of a static grid (requires at least 2 images)
Delay between animation frames in milliseconds; -1 disables animation
Datetime this record was first created
Customization configuration identifier
Localized title and description of the list (at least one entry in English required)
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique identifier for this record.
Keywords and metadata tags for SEO and filtering
Distinguishes the auto-created favorites list from any other curated list; present for CURATED lists only
Datetime this record was last updated
The ranked destination this list displays inventory from; present for RANKED lists only
object
Name of the closest city where this lookup entry is located
ISO 3166-1 alpha-2 country code
Country name where this lookup entry is located
Datetime this record was first created
Unique identifier for this record.
Language code for the lookup name (ISO 639-1 format)
Datetime this record was last updated
Geo-location
object
Human-readable name of the lookup entry
Name of the owner (supplier) that created this lookup entry
State or province where this lookup entry is located
County or district where this lookup entry is located
Type of lookup (CITY, HOTEL, ACTIVITY, SPA, RESTAURANT, ATTRACTION, ISLAND, COUNTRY, PLACE, MEETING_ROOM)
Unique identifier for the lookup type resource (e.g., hotel ID, city geoname ID)
URL-friendly slug that uniquely identifies this lookup within its type and location
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Descriptive name of this list for seller use only
Managing entity (account owner) identifier
Badge type and sort order for display on web component (MEMBER, BEST_VALUE, TOP_RATED, etc.)
What this list is backed by: a curated set of embedded items, a saved search, or a ranked destination
Current status of the list (ACTIVE, INACTIVE, ARCHIVED)
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Owned pagination envelope: a page of content plus flat page metadata.
object
The elements on this page.
One item of an inventory grid. Every item is a hotel card; an entry that names a room rate adds roomFocus.
object
One property on a grid card: content plus neutral offers. Amounts are minor units of the property’s own currency (currency).
object
Indicative lowest nightly price in minor units of currency, for the caller’s channel scope. Not a quote: it ignores the searched dates and availability. Absent when the property has no band, and never returned by the ranked-by-agency search.
Indicative highest nightly price in minor units of currency, for the caller’s channel scope. Not a quote: it ignores the searched dates and availability. Absent when the property has no band, and never returned by the ranked-by-agency search.
object
object
Lightweight projection of a property aggregate, used for search results, listings, and map markers where not all property details are required.
object
Number of activites property has listed on its profile.
Number of add-ons property has on its profile.
Property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Aggregate score based on all current user reviews.
Supported OTA specification ARC code. See OTA geoname data
Number of attractions property has listed on its profile.
Whether property is available
Number of bookings for this property on the wink.travel platform.
Name of hotel brand
Name of hotel chain if applicable.
City location
object
Ascii name of city
Country
object
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
ISO code
Country name
ISO 3166-1 alpha-2 country code for the country this location belongs to
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
GeoName identifier
Coordinate points of the city
object
Name of city
Country sub division
object
Sub-country ascii name
Sub-country GeoNames identifier
Sub-country name
Country sub sub division
object
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
Official name of the county or district in its local script
IANA timezone identifier for the location
GeoNameLightweight type
Url name
Currency code for property.
Short and long welcome text
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
General manager of the property.
object
Localized welcome message from GM.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Profile image of the general manager.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Name of GM currently managing the property.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Unique hotel record identifier.
Property images.
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Timestamp of the last update to this property aggregate record.
Hotel local name if different from the trade name or if it is the local language.
Geo-location
object
Supported OTA specification LOC code. See OTA geoname data
Number of meeting rooms property has on its profile.
Hotel trade name
Number of rooms / keys for this property.
Number of places property has listed on its profile.
Basic property policy record.
object
When the guest can check in, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.
When the guest has to check out, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.
Indicates whether property allows children
When a property allows children, it can also indicate what the minimum age is for children to be allowed.
Indicates the availability of internet on the property.
Indicates where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
Monetary amount value
ISO 4217 currency code
If pets are allowed, property can further limit on weight.
Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Contact details for reservations desk
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Number of restaurants property has on its profile.
Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.
Supported OTA specification SEG code. See OTA geoname data
Property’s social network accounts
Social network
object
URL or social network identifier to social network profile
Type of social network.
Number of spas property has on its profile.
Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Count of total reviews left by users at this property.
Event shorter name
Unique URL-friendly name slug of hotel
Property videos.
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Year the property was constructed.
A perk bundled with one or more of the item’s rates; rates reference it by id.
object
object
A lightweight projection of a room type, carrying all occupancy, bedroom configuration, pricing and classification details needed for availability and booking flows.
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). See OTA geoname data
Number of bathrooms
A room type can have more than one bed configuration.
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Indicate whether sales channels receive commission for selling this inventory.
Indicates that the room (suite) is a composite of smaller units.
Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Floor number on which this room type is located.
Hotel identifier.
Unique identifier for this record.
The number of pax the room price was meant for
The number of children the room price was meant for
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Number of living rooms
Geo-location point where blocking takes place. Defaults to location of property.
object
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Maximum number of cribs allowed in a room type.
Maximum number of guest allowed in a room type.
Maximum number of rollaway beds allowed in this room type.
Supported OTA specification AQC code. See OTA geoname data
Minimum number of guests allowed in a room type.
List of images / videos of blocking.
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Internal name of inventory.
Non-smoking indicator
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Defines the number of rooms of this type
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). See OTA geoname data
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Number of square meters that defines the size of this room type.
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
object
object
object
object
object
Ids of the perks bundled with this rate. Perks are static content: resolve each id via inventory/content?include=PERK, which lists the property’s perks with their descriptions.
object
The add-on this offer prices: the id of its static content (inventory/content with include=ADD_ON) and of the matching entry in OfferedRate.addOnIds. Name, descriptions and media are there; this offer carries only the price. Present on add-on offers and on venue (restaurant, spa and so on) offers alike, since a venue is priced from its add-ons.
Localized promotion copy attached by the price calculator when a discount or surcharge applies to this offer; empty otherwise. Not the promo code, which is ‘promotion’.
object
Pricing granularity that determines how a rate or fee is calculated and applied
One property on a grid card: content plus neutral offers. Amounts are minor units of the property’s own currency (currency).
object
Indicative lowest nightly price in minor units of currency, for the caller’s channel scope. Not a quote: it ignores the searched dates and availability. Absent when the property has no band, and never returned by the ranked-by-agency search.
Indicative highest nightly price in minor units of currency, for the caller’s channel scope. Not a quote: it ignores the searched dates and availability. Absent when the property has no band, and never returned by the ranked-by-agency search.
object
object
Lightweight projection of a property aggregate, used for search results, listings, and map markers where not all property details are required.
object
Number of activites property has listed on its profile.
Number of add-ons property has on its profile.
Property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Aggregate score based on all current user reviews.
Supported OTA specification ARC code. See OTA geoname data
Number of attractions property has listed on its profile.
Whether property is available
Number of bookings for this property on the wink.travel platform.
Name of hotel brand
Name of hotel chain if applicable.
City location
object
Ascii name of city
Country
object
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
ISO code
Country name
ISO 3166-1 alpha-2 country code for the country this location belongs to
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
GeoName identifier
Coordinate points of the city
object
Name of city
Country sub division
object
Sub-country ascii name
Sub-country GeoNames identifier
Sub-country name
Country sub sub division
object
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
Official name of the county or district in its local script
IANA timezone identifier for the location
GeoNameLightweight type
Url name
Currency code for property.
Short and long welcome text
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
General manager of the property.
object
Localized welcome message from GM.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Profile image of the general manager.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Name of GM currently managing the property.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Unique hotel record identifier.
Property images.
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Timestamp of the last update to this property aggregate record.
Hotel local name if different from the trade name or if it is the local language.
Geo-location
object
Supported OTA specification LOC code. See OTA geoname data
Number of meeting rooms property has on its profile.
Hotel trade name
Number of rooms / keys for this property.
Number of places property has listed on its profile.
Basic property policy record.
object
When the guest can check in, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.
When the guest has to check out, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.
Indicates whether property allows children
When a property allows children, it can also indicate what the minimum age is for children to be allowed.
Indicates the availability of internet on the property.
Indicates where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
Monetary amount value
ISO 4217 currency code
If pets are allowed, property can further limit on weight.
Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Contact details for reservations desk
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Number of restaurants property has on its profile.
Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.
Supported OTA specification SEG code. See OTA geoname data
Property’s social network accounts
Social network
object
URL or social network identifier to social network profile
Type of social network.
Number of spas property has on its profile.
Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Count of total reviews left by users at this property.
Event shorter name
Unique URL-friendly name slug of hotel
Property videos.
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Year the property was constructed.
A perk bundled with one or more of the item’s rates; rates reference it by id.
object
object
A lightweight projection of a room type, carrying all occupancy, bedroom configuration, pricing and classification details needed for availability and booking flows.
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). See OTA geoname data
Number of bathrooms
A room type can have more than one bed configuration.
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Indicate whether sales channels receive commission for selling this inventory.
Indicates that the room (suite) is a composite of smaller units.
Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Floor number on which this room type is located.
Hotel identifier.
Unique identifier for this record.
The number of pax the room price was meant for
The number of children the room price was meant for
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Number of living rooms
Geo-location point where blocking takes place. Defaults to location of property.
object
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Maximum number of cribs allowed in a room type.
Maximum number of guest allowed in a room type.
Maximum number of rollaway beds allowed in this room type.
Supported OTA specification AQC code. See OTA geoname data
Minimum number of guests allowed in a room type.
List of images / videos of blocking.
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Internal name of inventory.
Non-smoking indicator
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Defines the number of rooms of this type
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). See OTA geoname data
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Number of square meters that defines the size of this room type.
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
object
object
object
object
object
Ids of the perks bundled with this rate. Perks are static content: resolve each id via inventory/content?include=PERK, which lists the property’s perks with their descriptions.
object
The add-on this offer prices: the id of its static content (inventory/content with include=ADD_ON) and of the matching entry in OfferedRate.addOnIds. Name, descriptions and media are there; this offer carries only the price. Present on add-on offers and on venue (restaurant, spa and so on) offers alike, since a venue is priced from its add-ons.
Localized promotion copy attached by the price calculator when a discount or surcharge applies to this offer; empty otherwise. Not the promo code, which is ‘promotion’.
object
Pricing granularity that determines how a rate or fee is calculated and applied
Type of sellable inventory that can be published and sold through the platform
Whether this is the first page.
Whether this is the last page.
Zero-based index of this page.
Number of elements on this page.
The requested page size.
Total number of elements across all pages.
Total number of pages for the current page size.
Example
{ "list": { "animate": false, "animateDelay": 500, "createdDate": "2026-01-14T09:30:00", "customizationIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords": [ "bangkok", "luxury" ], "kind": "NORMAL", "lastUpdate": "2026-02-03T16:45:12", "lookup": { "cityName": "Bangkok", "countryCode": "TH", "countryName": "Thailand", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode": "en", "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "Point" }, "name": "The Siam Residences", "ownerName": "The Siam Residences", "subCountryName": "Bangkok", "subSubCountryName": "Khlong San District", "type": "HOTEL", "typeIdentifier": "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName": "the-siam-residences-bangkok-thailand" }, "name": "Luxury Bangkok Properties", "sellerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort": "MEMBER", "source": "CURATED", "status": "ACTIVE", "version": 3 }, "page": { "content": [ { "roomFocus": { "hotel": { "activities": 3, "addOns": 5, "address": { "city": "Bangkok", "countryCode": "TH", "line1": "3/2 Khao Road", "postalCode": "10300", "state": "Bangkok" }, "aggregateGreendexRating": 7, "aggregateReviewRating": 8.7, "architecturalStyle": "7", "attractions": 5, "available": true, "bookings": 6054, "brand": "The Siam Residences", "chain": "The Siam Collection", "currencyCode": "THB", "descriptions": [ { "description": "An elegant riverside sanctuary in the heart of Bangkok.", "language": "en", "title": "Luxury Riverside Retreat" } ], "hotelAmenityCodes": [ "1", "7" ], "hotelCategory": "45", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "images": [ { "entityId": "the-siam-residences/lobby-entrance", "identifier": "the-siam-residences/lobby-entrance", "sort": 10, "type": "IMAGE" } ], "lifestyleTypes": [ "LIFESTYLE_HEALTH_FITNESS" ], "localName": "เดอะสยาม เรสซิเดนซ์", "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "Point" }, "locationCategory": "34", "meetingRooms": 2, "name": "The Siam Residences, Bangkok", "numberOfRooms": 32, "places": 9, "propertyAccessibilityCodes": [ "1" ], "propertySecurityCodes": [ "7" ], "reservations": { "firstName": "Somchai", "lastName": "Phattanapong", "phone": "+66-2-123-4567" }, "restaurants": 2, "score": 70, "segmentCategory": "7", "socials": [ { "handle": "thesiamresidences", "platform": "INSTAGRAM" } ], "spas": 1, "starRating": 5, "thirdPartyReviews": [], "totalReviews": 989, "uniqueId": "siam-residences-bkk", "urlName": "the-siam-residences-bangkok-thailand", "videos": [], "whenBuilt": "1927" }, "roomTypeList": [ { "active": true, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "city": "Bangkok", "country": "United States", "countryCode": "TH", "county": "Alameda county", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States", "postalCode": "90210", "state": "CA" }, "bathroomCount": 0, "bedroomConfigurationList": [ { "bedroomList": [ { "bedList": [ { "bedTypeCode": "1", "quantity": 2 } ], "type": "MASTER" } ], "identifier": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "name": "Master Suite Layout" } ], "bookable": true, "commissionable": true, "composite": false, "compositeCount": 2, "contact": { "firstName": "Alexandra", "fullName": "Alexandra Beaumont", "lastName": "Beaumont", "phoneNumber": "+12125551212", }, "createdDate": "2026-01-14T09:30:00", "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "featuredInd": false, "floor": "3", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "includedAdultOccupancy": 2, "includedChildOccupancy": 0, "lastUpdate": "2026-02-03T16:45:12", "lifestyleType": "LIFESTYLE_HEALTH_FITNESS", "livingRoomCount": 0, "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "POINT" }, "maxAdultOccupancy": 1, "maxChildOccupancy": 0, "maxCribs": 1, "maxOccupancy": 2, "maxRollaways": 0, "minAgeAppropriateCode": "1", "minOccupancy": 1, "multimedias": [ { "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "entityId": "the-siam-residences/lobby-entrance", "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "lifestyleType": null, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "Archery lesson", "nonSmoking": true, "pricePoint": "THREE", "proximityCode": "1", "publishStatus": "PUBLISHED", "quantity": 40, "recognitionList": [ { "category": "AWARD", "date": "2026-01-14", "identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "maxRating": 10, "officialAppointmentInd": true, "provider": "Michelin", "rating": 8.5, "ratingSymbol": "*", "type": "PERCENT_RATING" } ], "roomArchitectureCode": "1", "roomCategory": "1", "roomClassificationCode": "1", "roomGender": "Female", "roomLocationCode": "1", "roomViewCode": "1", "sharedRoomInd": false, "size": 55, "socials": [ { "location": "https://www.instagram.com/thesiamresidences", "type": "INSTAGRAM" } ], "sort": 1, "version": 3 } ] }, "roomType": { "hotel": { "activities": 3, "addOns": 5, "address": { "city": "Bangkok", "countryCode": "TH", "line1": "3/2 Khao Road", "postalCode": "10300", "state": "Bangkok" }, "aggregateGreendexRating": 7, "aggregateReviewRating": 8.7, "architecturalStyle": "7", "attractions": 5, "available": true, "bookings": 6054, "brand": "The Siam Residences", "chain": "The Siam Collection", "currencyCode": "THB", "descriptions": [ { "description": "An elegant riverside sanctuary in the heart of Bangkok.", "language": "en", "title": "Luxury Riverside Retreat" } ], "hotelAmenityCodes": [ "1", "7" ], "hotelCategory": "45", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "images": [ { "entityId": "the-siam-residences/lobby-entrance", "identifier": "the-siam-residences/lobby-entrance", "sort": 10, "type": "IMAGE" } ], "lifestyleTypes": [ "LIFESTYLE_HEALTH_FITNESS" ], "localName": "เดอะสยาม เรสซิเดนซ์", "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "Point" }, "locationCategory": "34", "meetingRooms": 2, "name": "The Siam Residences, Bangkok", "numberOfRooms": 32, "places": 9, "propertyAccessibilityCodes": [ "1" ], "propertySecurityCodes": [ "7" ], "reservations": { "firstName": "Somchai", "lastName": "Phattanapong", "phone": "+66-2-123-4567" }, "restaurants": 2, "score": 70, "segmentCategory": "7", "socials": [ { "handle": "thesiamresidences", "platform": "INSTAGRAM" } ], "spas": 1, "starRating": 5, "thirdPartyReviews": [], "totalReviews": 989, "uniqueId": "siam-residences-bkk", "urlName": "the-siam-residences-bangkok-thailand", "videos": [], "whenBuilt": "1927" }, "roomTypeList": [ { "active": true, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "city": "Bangkok", "country": "United States", "countryCode": "TH", "county": "Alameda county", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States", "postalCode": "90210", "state": "CA" }, "bathroomCount": 0, "bedroomConfigurationList": [ { "bedroomList": [ { "bedList": [ { "bedTypeCode": "1", "quantity": 2 } ], "type": "MASTER" } ], "identifier": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "name": "Master Suite Layout" } ], "bookable": true, "commissionable": true, "composite": false, "compositeCount": 2, "contact": { "firstName": "Alexandra", "fullName": "Alexandra Beaumont", "lastName": "Beaumont", "phoneNumber": "+12125551212", }, "createdDate": "2026-01-14T09:30:00", "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "featuredInd": false, "floor": "3", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "includedAdultOccupancy": 2, "includedChildOccupancy": 0, "lastUpdate": "2026-02-03T16:45:12", "lifestyleType": "LIFESTYLE_HEALTH_FITNESS", "livingRoomCount": 0, "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "POINT" }, "maxAdultOccupancy": 1, "maxChildOccupancy": 0, "maxCribs": 1, "maxOccupancy": 2, "maxRollaways": 0, "minAgeAppropriateCode": "1", "minOccupancy": 1, "multimedias": [ { "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "entityId": "the-siam-residences/lobby-entrance", "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "lifestyleType": null, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "Archery lesson", "nonSmoking": true, "pricePoint": "THREE", "proximityCode": "1", "publishStatus": "PUBLISHED", "quantity": 40, "recognitionList": [ { "category": "AWARD", "date": "2026-01-14", "identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "maxRating": 10, "officialAppointmentInd": true, "provider": "Michelin", "rating": 8.5, "ratingSymbol": "*", "type": "PERCENT_RATING" } ], "roomArchitectureCode": "1", "roomCategory": "1", "roomClassificationCode": "1", "roomGender": "Female", "roomLocationCode": "1", "roomViewCode": "1", "sharedRoomInd": false, "size": 55, "socials": [ { "location": "https://www.instagram.com/thesiamresidences", "type": "INSTAGRAM" } ], "sort": 1, "version": 3 } ] } } ], "first": true, "last": false, "number": 0, "numberOfElements": 20, "size": 20, "totalElements": 1234, "totalPages": 62 }}Bad Request — missing or invalid request parameter or body
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Unauthorized — authentication is required or the session has expired
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Forbidden — authenticated but lacking the required permission or scope
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Not Found — the requested resource does not exist
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Unsupported Media Type — use application/json
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Internal Server Error — an unexpected failure occurred on the server
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Service Unavailable — a downstream dependency is unreachable
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}