Skip to content
Wink

Show Properties

GET
/api/channel-manager/property/list
 
curl --request GET \
  --url 'https://integrations.wink.travel/api/channel-manager/property/list?page=0&size=25' \
  --header 'Wink-Version: 2.0'

The properties endpoint provides the entry point into the listener and is used to list properties you have access to.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
string
default: ##default

Page through all properties owned by your account

Example 
0
size
string
default: ##default

Limit results of records per page

Example 
25

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
object
totalElements
integer format: int64
totalPages
integer format: int32
size
integer format: int32
content
Array<object>
object
identifier
required

Property ID

string format: uuid
default: ##default >= 1 characters
name
required

Property name

string
default: ##default >= 1 characters
city
required

City property is located in or near

string
default: ##default >= 1 characters
countryCode
required

Country code property is located in

string
default: ##default >= 1 characters
currencyCode
required

Currency code property uses

string
default: ##default >= 1 characters
timeZone
required

Timezone property is located in

string
default: ##default >= 1 characters
number
integer format: int32
sort
object
empty
boolean
sorted
boolean
unsorted
boolean
numberOfElements
integer format: int32
pageable
object
offset
integer format: int64
sort
object
empty
boolean
sorted
boolean
unsorted
boolean
pageSize
integer format: int32
paged
boolean
pageNumber
integer format: int32
unpaged
boolean
first
boolean
last
boolean
empty
boolean
Example 
{
  "content": [
    {
      "identifier": "##default",
      "name": "##default",
      "city": "##default",
      "countryCode": "##default",
      "currencyCode": "##default",
      "timeZone": "##default"
    }
  ]
}

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