Skip to content
Wink

List grids

GET
/api/managing-entity/{managingEntityIdentifier}/studio/grids/list
 
curl --request GET \
  --url https://api.wink.travel/api/managing-entity/c9f7e4e0-3d6f-6c1e-0f5f-8f2d4e7c3f15/studio/grids/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Wink-Version: 2.0'

Lists all curated and saved-search grids owned by the managing entity.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Managing entity identifier that owns the grids.

Example 
c9f7e4e0-3d6f-6c1e-0f5f-8f2d4e7c3f15

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
Array<object>
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
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
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
Example 
[
  {
    "id": "",
    "createdDate": "",
    "lastUpdate": "",
    "version": "",
    "ownerIdentifier": "",
    "name": "",
    "customizationIdentifier": "",
    "descriptions": "",
    "keywords": "",
    "status": "ACTIVE",
    "listType": "SINGLE",
    "listIdentifier": "",
    "animate": false,
    "animateDelay": -1,
    "sort": "MEMBER",
    "displayType": "NATIVE"
  }
]

400

Section titled “400 ”

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}