Skip to content
Wink

List registered mappings

GET
/api/property-embeddings/external/mappings
 
curl --request GET \
  --url https://api.wink.travel/api/property-embeddings/external/mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Wink-Version: 2.0'

Returns every external ID mapping registered by the calling application. Includes hotelId, externalId, and management metadata.

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 ”

List of mappings retrieved successfully

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
""
hotelId

Internal hotel identifier in the property_embeddings vector store

string
""
namespace

Partner namespace (always PARTNER for externally registered mappings)

string
""
externalId

The partner’s identifier for this property within their namespace

string
""
ownerIdentifier

OAuth2 application (client) identifier of the partner that registered this mapping

string
""
Example 
[
  {
    "id": "",
    "createdDate": "",
    "lastUpdate": "",
    "version": "",
    "hotelId": "",
    "namespace": "",
    "externalId": "",
    "ownerIdentifier": ""
  }
]

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 ”

Missing or invalid JWT authentication

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