Skip to content
Wink

List all perks

GET
/reference-data/perk/list
 
curl --request GET \
  --url https://api.wink.travel/reference-data/perk/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Wink-Version: 2.0'

Retrieves every perk available in the platform’s reference data, sorted by display order (ascending). Each perk includes a unique identifier, guarantee status, platform tier, and localized descriptions in multiple languages. This endpoint is public and does not require authentication.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

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

Unique enum-like string identifier for this perk (e.g., PERK_GUARANTEED_UPGRADE). Enables backwards compatibility by persisting the identifier rather than relying on ordinal position.

string
"" >= 1 characters
guaranteed

Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.

boolean
level

Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.

integer format: int32
""
descriptions
required

Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).

Array<object>
"" >= 1 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
sort

Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.

integer format: int32
""
Example 
[
  {
    "identifier": "",
    "guaranteed": false,
    "level": "",
    "descriptions": "",
    "sort": ""
  }
]

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
{}