Skip to content

Show

GET
/api/managing-entity/{managingEntityIdentifier}/studio/grids/{listIdentifier}
curl --request GET \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/grids/3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51 \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Retrieves a single curated or saved-search grid by its identifier, scoped to the owning managing entity; returns 404 if not found.

managingEntityIdentifier
required
string
""

Managing entity identifier that owns the grid.

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

Grid identifier to retrieve.

Example
3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

The curated or saved-search grid matching the given identifier.

Media type application/json

Persisted sellable list configuration that groups inventory items for display as a curated grid or collection on a seller’s web component

object
id

Document UUID

string format: uuid
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
ownerIdentifier
required

Managing entity (account owner) identifier

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

Descriptive name of this grid for seller use only

string
"" >= 1 characters
customizationIdentifier
required

Customization configuration identifier

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

Contains localized title and description of grid (at least one entry in English required)

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
name
required

Use as title or short text description

string
""
description
required

Longer text description

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

Indicate which language this description is written in.

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

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
keywords
required

Keywords and metadata tags for the grid used for SEO and filtering purposes

Array<string>
"" >= 1 items <= 2147483647 items
status
required

Current status of the grid (ACTIVE, INACTIVE, ARCHIVED)

string
default: ACTIVE
Allowed values: ACTIVE INACTIVE REMOVED
listType
required

List type

string
""
Allowed values: SINGLE LIST SEARCH
listIdentifier
required

Inventory record identifier for the curated list, saved search, or channel (format varies by listType)

string format: uuid
"" >= 1 characters
animate

Generate an animated GIF from multiple images instead of a static grid (requires at least 2 images)

boolean
animateDelay

Delay between animation frames in milliseconds; -1 disables animation

integer format: int32
default: -1
sort

Badge type and sort order for display on the web component (MEMBER, BEST_VALUE, TOP_RATED, etc.)

string
""
Allowed values: MEMBER PRICE_LOW_TO_HIGH PRICE_HIGH_TO_LOW PRICE POPULARITY ECO EXPERIENCE PERK LOYALTY ADD_ON
displayType
required

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

string
default: NATIVE
Allowed values: NATIVE HOTEL ROOM
key
additional properties
""
Example
{
"id": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"createdDate": "2026-01-14T09:30:00",
"lastUpdate": "2026-01-15T09:30:00",
"version": 1,
"ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69",
"name": "Luxury Bangkok Properties",
"customizationIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"descriptions": [],
"keywords": [
"bangkok",
"luxury"
],
"status": "ACTIVE",
"listType": "LIST",
"listIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18",
"animate": false,
"animateDelay": -1,
"sort": "MEMBER",
"displayType": "NATIVE"
}

Bad Request — missing or invalid request parameter or body

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

Unauthorized — authentication is required or the session has expired

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

Forbidden — authenticated but lacking the required permission or scope

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

Not Found — the requested resource does not exist

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

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

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

Unsupported Media Type — use application/json

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

Internal Server Error — an unexpected failure occurred on the server

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

Service Unavailable — a downstream dependency is unreachable

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