Show all

GET

/api/managing-entity/{managingEntityIdentifier}/wink-links/shortened-url/list

const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/wink-links/shortened-url/list';
const options = {
  method: 'GET',
  headers: {'Wink-Version': '2.0', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/wink-links/shortened-url/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Wink-Version: 2.0'

Lists every shortened URL owned by the managing entity.

Authorizations

oauth2ClientCredentials

Parameters

Path Parameters

managingEntityIdentifier

required

string format: uuid

Managing entity identifier to list shortened URLs for

Example

d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Responses

200

List of all shortened URLs belonging to the managing entity

application/json

Array<object>

Lightweight, read-only projection of a shortened URL, used by cross-domain consumers.

object

audioList

Open Graph audio media extracted from the target URL.

Array<object>

Open Graph media asset (image, video, or audio)

object

alt

Alternative text description for accessibility

string

height

Media height in pixels

string

secureUrl

HTTPS URL of the media asset

string format: uri

type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string

url

required

URL of the media asset

string format: uri

>= 1 characters

width

Media width in pixels

string

createdDate

Datetime this record was first created

string | null format: date-time

descriptions

Localized descriptions of the shortened URL entry.

Array<object>

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

entityId

Entity identifier that the uniqueId originates from. Empty for type=URL.

string format: uuid

Unique identifier for this record.

string format: uuid

imageList

Open Graph images extracted from the target URL.

Array<object>

Open Graph media asset (image, video, or audio)

object

alt

Alternative text description for accessibility

string

height

Media height in pixels

string

secureUrl

HTTPS URL of the media asset

string format: uri

type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string

url

required

URL of the media asset

string format: uri

>= 1 characters

width

Media width in pixels

string

lastUpdate

Datetime this record was last updated

string | null format: date-time

metadata

Extended metadata key-value pairs (e.g., seo keywords, tags).

object

key

additional properties

multimedias

Primary media assets associated with this shortened URL.

Array<object>

Multimedia that contains less information than Multimedia object

object

angle

Media angle

string

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

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

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Use this identifier to communicate with Cloudinary.

string

>= 1 characters

isLandscape

True if media width is greater or equal to height

boolean

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

Allowed values: LIFESTYLE_HEALTH_FITNESS LIFESTYLE_RELAX LIFESTYLE_ADULT_ONLY LIFESTYLE_ADVENTURE LIFESTYLE_BUSINESS LIFESTYLE_LGBT LIFESTYLE_SINGLE_PARENT LIFESTYLE_SOLO_FEMALE LIFESTYLE_BEAUTY LIFESTYLE_FOODIE LIFESTYLE_FAMILY LIFESTYLE_ROMANCE LIFESTYLE_COUPLE LIFESTYLE_SOLO LIFESTYLE_BACKPACKER LIFESTYLE_SHOPPING LIFESTYLE_SPORTS LIFESTYLE_MOUNTAIN LIFESTYLE_BEACH LIFESTYLE_CITY LIFESTYLE_COUNTRY LIFESTYLE_CULTURE LIFESTYLE_ECO

multimediaIdentifier

required

Document identifier

string format: uuid

>= 1 characters

published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

width

required

Media width in pixels.

integer format: int32

>= 1

ownerIdentifier

Managing entity / owner identifier that owns this shortened URL.

string format: uuid

previousUniqueIds

Previous URL slugs maintained for SEO and backward compatibility.

Array<string>

title

Display name of the shortened URL.

string

type

Type of entity the uniqueId links to (URL, PROPERTY, BOOKING, etc.).

string

Allowed values: SELLABLE_INVENTORY_SLUG SELLABLE_SUPPLIER_SLUG AFFILIATE_ACCOUNT_SLUG SYNDICATED_ITEM_SLUG URL

uniqueId

URL-friendly slug that uniquely identifies this entry within the owner’s account.

string

url

Target URL to redirect to. Required when type=URL, omitted for other types.

string format: uri

userIdentifier

Creator of this shortened URL.

string format: uuid

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

videoList

Open Graph videos extracted from the target URL.

Array<object>

Open Graph media asset (image, video, or audio)

object

alt

Alternative text description for accessibility

string

height

Media height in pixels

string

secureUrl

HTTPS URL of the media asset

string format: uri

type

MIME type of the media (image/jpeg, video/mp4, audio/mpeg, etc.)

string

url

required

URL of the media asset

string format: uri

>= 1 characters

width

Media width in pixels

string

Example

[
  {
    "audioList": [
      {
        "alt": "The Siam Residences exterior view",
        "height": "630",
        "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
        "type": "image/jpeg",
        "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
        "width": "1200"
      }
    ],
    "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"
      }
    ],
    "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47",
    "imageList": [
      {
        "alt": "The Siam Residences exterior view",
        "height": "630",
        "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
        "type": "image/jpeg",
        "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
        "width": "1200"
      }
    ],
    "lastUpdate": "2026-02-03T16:45:12",
    "multimedias": [
      {
        "angle": null,
        "attribution": [],
        "category": "2",
        "descriptions": [
          {
            "description": "Elegant lobby of The Siam Residences",
            "language": "en",
            "title": "Lobby Entrance"
          }
        ],
        "height": 1600,
        "identifier": "the-siam-residences/lobby-entrance",
        "isLandscape": true,
        "lifestyleType": null,
        "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
        "published": true,
        "sort": 10,
        "source": "CLOUDINARY",
        "type": "IMAGE",
        "width": 2560
      }
    ],
    "version": 3,
    "videoList": [
      {
        "alt": "The Siam Residences exterior view",
        "height": "630",
        "secureUrl": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
        "type": "image/jpeg",
        "url": "https://res.cloudinary.com/traveliko/image/upload/v1689655191/the-siam-residences-bangkok.jpg",
        "width": "1200"
      }
    ]
  }
]

400

Bad Request — missing or invalid request parameter or body

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

401

Unauthorized — authentication is required or the session has expired

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

403

Forbidden — authenticated but lacking the required permission or scope

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

404

Not Found — the requested resource does not exist

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

405

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

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

409

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

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

415

Unsupported Media Type — use application/json

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

500

Internal Server Error — an unexpected failure occurred on the server

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

503

Service Unavailable — a downstream dependency is unreachable

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

Show all

Authorizations

Parameters

Path Parameters

Example

Header Parameters

Responses

200

Example

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

405

Examplegenerated

409

Examplegenerated

415

Examplegenerated

500

Examplegenerated

503

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated