Skip to content

Show one

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

Loads a single shortened URL by its identifier.

managingEntityIdentifier
required
string format: uuid
""

Managing entity identifier that owns the shortened URL

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
shortenedUrlIdentifier
required
string format: uuid
""

Identifier of the shortened URL to retrieve

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

The requested shortened URL

Media typeapplication/json

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

object
id

Unique identifier for this record.

string format: uuid
""
createdDate

Datetime this record was first created

string | null format: date-time
""
lastUpdate

Datetime this record was last updated

string | null format: date-time
""
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
""
userIdentifier

Creator of this shortened URL.

string format: uuid
""
ownerIdentifier

Managing entity / owner identifier that owns this shortened URL.

string format: uuid
""
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
""
entityId

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

string format: uuid
""
url

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

string format: uri
""
imageList

Open Graph images extracted from the target URL.

Array<object>
""

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

object
url
required

URL of the media asset

string format: uri
"" >= 1 characters
secureUrl

HTTPS URL of the media asset

string format: uri
""
type

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

string
""
width

Media width in pixels

string
""
height

Media height in pixels

string
""
alt

Alternative text description for accessibility

string
""
videoList

Open Graph videos extracted from the target URL.

Array<object>
""

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

object
url
required

URL of the media asset

string format: uri
"" >= 1 characters
secureUrl

HTTPS URL of the media asset

string format: uri
""
type

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

string
""
width

Media width in pixels

string
""
height

Media height in pixels

string
""
alt

Alternative text description for accessibility

string
""
audioList

Open Graph audio media extracted from the target URL.

Array<object>
""

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

object
url
required

URL of the media asset

string format: uri
"" >= 1 characters
secureUrl

HTTPS URL of the media asset

string format: uri
""
type

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

string
""
width

Media width in pixels

string
""
height

Media height in pixels

string
""
alt

Alternative text description for accessibility

string
""
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
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
multimedias

Primary media assets associated with this shortened URL.

Array<object>
""

Multimedia that contains less information than Multimedia object

object
multimediaIdentifier
required

Document identifier

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

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
source
required

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

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
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
angle

Media angle

string
""
width
required

Media width in pixels.

integer format: int32
"" >= 1
height
required

Media height in pixels.

integer format: int32
"" >= 1
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
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
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
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
attribution

Whether image has attribution properties

Array<object>
""
object
url

URL to contributor

string format: uri
""
name
required

Name of contributor

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

boolean
metadata

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

object
key
additional properties
previousUniqueIds

Previous URL slugs maintained for SEO and backward compatibility.

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

Bad Request — missing or invalid request parameter or body

Media typeapplication/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 typeapplication/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 typeapplication/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 typeapplication/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 typeapplication/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

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
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 typeapplication/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 typeapplication/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 typeapplication/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