Skip to content

Show

GET
/api/managing-entity/{managingEntityIdentifier}/studio/ranked-grids/{listIdentifier}
curl --request GET \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/ranked-grids/8f3a2c6e-1d5b-4a7f-9e2c-0b4d6a1f8e5c \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Loads a single ranked grid owned by the managing entity. Returns 404 if the grid does not exist. Requires MARKETING:READ permission.

managingEntityIdentifier
required
string
""

Managing entity identifier

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
listIdentifier
required
string
""

Ranked grid identifier

Example
8f3a2c6e-1d5b-4a7f-9e2c-0b4d6a1f8e5c
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

The ranked grid matching the supplied identifier

Media typeapplication/json

Lightweight projection of a ranked sellable list used in listings and event payloads, containing all display and configuration fields without audit metadata

object
animate

Create an animated gif instead of a list of images

boolean
animateDelay

Controls animation delay in milliseconds; -1 to disable

integer format: int32
default: -1
createdDate

Datetime this record was first created

string | null format: date-time
""
customizationIdentifier
required

Customization identifier

string format: uuid
"" >= 1 characters
descriptions
required

Contains custom title and description of grid

Array<object>
"" >= 1 items <= 2147483647 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
hashMismatch
boolean
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/
md5ContentHash

The md5 hash of the name, description and language.

string
""
name
required

Use as title or short text description

string
""
displayType

Indicate which initial values to display first on the front-facing card

string
default: NATIVE
Allowed values: NATIVE HOTEL ROOM
id

Unique identifier for this record.

string format: uuid
""
keywords
required
Array<string>
>= 1 items <= 2147483647 items
lastUpdate

Datetime this record was last updated

string | null format: date-time
""
lookup
required

The destination to display ranked inventory from.

object
cityName

Name of the closest city where this lookup entry is located

string
""
countryCode

ISO 3166-1 alpha-2 country code

string
""
countryName

Country name where this lookup entry is located

string
""
createdDate

Datetime this record was first created

string | null format: date-time
""
id

Unique identifier for this record.

string format: uuid
""
languageCode

Language code for the lookup name (ISO 639-1 format)

string
""
lastUpdate

Datetime this record was last updated

string | null format: date-time
""
location
required

Geo-location

object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
lowercaseName

Lowercase version of the name, used for regex-based search operations. Extranet surfaces only.

string
""
name

Human-readable name of the lookup entry

string
""
origin

Whether this is the primary/original lookup entry for this resource (true) or a variant like an alternate language or name (false). Extranet surfaces only.

boolean
ownerIdentifier

Identifier of the owner (supplier) that created or manages this lookup entry. Extranet surfaces only — not serialized on public or partner endpoints.

string format: uuid
""
ownerName

Name of the owner (supplier) that created this lookup entry

string
""
ownerType

Type of owner that created this lookup (TRAVELIKO for platform-managed entries, HOTEL for supplier-created entries). Extranet surfaces only.

string
""
Allowed values: TRAVELIKO HOTEL
sort

Platform-specific sort order (lower values sort first: CITY=1, ISLAND=2, HOTEL=3, others vary). Extranet surfaces only.

integer format: int32
""
subCountryName

State or province where this lookup entry is located

string
""
subSubCountryName

County or district where this lookup entry is located

string
""
type

Type of lookup (CITY, HOTEL, ACTIVITY, SPA, RESTAURANT, ATTRACTION, ISLAND, COUNTRY, PLACE, MEETING_ROOM)

string
""
Allowed values: CITY ISLAND HOTEL SPA MEETING_ROOM RESTAURANT ATTRACTION ACTIVITY PLACE COUNTRY
typeIdentifier

Unique identifier for the lookup type resource (e.g., hotel ID, city geoname ID)

string format: uuid
""
urlName

URL-friendly slug that uniquely identifies this lookup within its type and location

string
""
version

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.

integer | null format: int64
""
name
required

Descriptive name of this list for seller use only

string
"" >= 1 characters
ownerIdentifier
required

AffiliateAccount identifier

string format: uuid
"" >= 1 characters
sort

Determines which badge to show on the Web Component. Is also used to sort properties for search grids.

string
""
Allowed values: RECOMMENDED PRICE_LOW_TO_HIGH PRICE_HIGH_TO_LOW ECO
status
required

Status

string
default: ACTIVE
Allowed values: ACTIVE INACTIVE REMOVED
version

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.

integer | null format: int64
""
key
additional properties
""
Example
{
"animate": false,
"animateDelay": 500,
"createdDate": "2026-01-14T09:30:00",
"customizationIdentifier": "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d",
"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"
}
],
"displayType": "NATIVE",
"id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47",
"keywords": [
"luxury"
],
"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": "Featured Luxury Resorts Bangkok",
"ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69",
"sort": "MEMBER",
"status": "ACTIVE",
"version": 3
}

Bad Request — missing or invalid request parameter or body

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Unauthorized — authentication is required or the session has expired

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Forbidden — authenticated but lacking the required permission or scope

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Not Found — the requested resource does not exist

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Unsupported Media Type — use application/json

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Internal Server Error — an unexpected failure occurred on the server

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Service Unavailable — a downstream dependency is unreachable

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example