Show Lead List

GET

/api/lead/list

const url = 'https://api.wink.travel/api/lead/list';
const options = {method: 'GET', headers: {'Wink-Version': '2.0'}};

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/lead/list \
  --header 'Wink-Version: 2.0'

Retrieves a list of leads you’ve created.

Parameters

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Responses

200

application/json

Array<object>

object

Document UUID

string

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

user

required

The user who initiated the creation of this object. Contains userId as value and username as label.

object

value

required

The value that should be persisted.

string

"" >= 1 characters

label

required

English readable text of the value.

string

"" >= 1 characters

owner

Usually the company account ID that the lead occurred under. Contains company ID as value and company name as label.

object

value

required

The value that should be persisted.

string

"" >= 1 characters

label

required

English readable text of the value.

string

"" >= 1 characters

status

required

Lead status

string

Allowed values: CREATED IN_PROGRESS INVITED CLAIMED REJECTED INACTIVE

placeId

required

Unique ID

string

"" >= 1 characters

nameInEnglish

required

Name of lead

string

"" >= 1 characters

nameInLocalLanguage

Name of lead in local language

string

googleMapsUrl

required

Google Maps URL of the place

string

"" >= 1 characters

phone

Telephone of lead

string

address

Address in English

object

address1

Address line 1

string

address2

Address line 2

string

state

State

string

postalCode

Postal / zip code

string

county

County

string

city

City name

string

countryCode

Country

string

country

Country

string

fullAddress

Address 1, Address 2, City, State, Postal / Zip code, Country

string

addressLocal

Address in local language if available

object

address1

Address line 1

string

address2

Address line 2

string

state

State

string

postalCode

Postal / zip code

string

county

County

string

city

City name

string

countryCode

Country

string

country

Country

string

fullAddress

Address 1, Address 2, City, State, Postal / Zip code, Country

string

formattedAddress

Formatted address in English

string

formattedAddressLocal

Formatted address in local language if available

string

htmlAddress

Html address in English

string

htmlAddressLocal

Html address in local language if available

string

location

required

Country

object

number format: double

type

string

coordinates

Array<number>

photos

Photos for property

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>

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

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

name

required

Name of contributor

string

"" >= 1 characters

isLandscape

True if media width is greater or equal to height

boolean

rating

Hotel rating

number format: float

userRatingTotal

Total umber of user ratings

integer format: int32

utcOffsetMinutes

required

UTC offset minutes

integer format: int32

website

Website

string

messageFromUser

A personalized message from the inviter

string

cityOptions

Array<object>

Sometimes there is more than one hit when trying to find the GeoNameLightweight for the Google Place city. In this case we save all of them and let the user decide.

object

geoNameId

GeoName identifier

string

type

GeoNameLightweight type

string

Allowed values: CITY ISLAND OTHER

name

Name of city

string

urlName

Url name

string

asciiName

Ascii name of city

string

location

Coordinate points of the city

object

number format: double

type

string

coordinates

Array<number>

featureCode

string

countryCode

string

timezone

Timezone

string

country

Country

object

iso

ISO code

string

name

Country name

string

capital

Country capital

string

continent

Continent code

string

currencyCode

Currency code

string

currencyName

Currency name

string

geoNameId

Country GeoNames identifier

string

subCountry

Country sub division

object

name

Sub-country name

string

asciiName

Sub-country ascii name

string

geoNameId

Sub-country GeoNames identifier

string

subSubCountry

Country sub sub division

object

name

string

asciiName

string

geoNameId

string

descriptions

Array<object>

Leverages AI to pre-populate the description.

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

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

Example

[
  {
    "id": "",
    "createdDate": "",
    "lastUpdate": "",
    "version": "",
    "user": "",
    "owner": "",
    "status": "CREATED",
    "placeId": "",
    "nameInEnglish": "",
    "nameInLocalLanguage": "",
    "googleMapsUrl": "",
    "phone": "",
    "address": null,
    "addressLocal": null,
    "formattedAddress": "",
    "formattedAddressLocal": "",
    "htmlAddress": "",
    "htmlAddressLocal": "",
    "location": "",
    "photos": "",
    "rating": "",
    "userRatingTotal": "",
    "utcOffsetMinutes": "",
    "website": "",
    "messageFromUser": "",
    "cityOptions": [
      null
    ],
    "descriptions": [
      ""
    ]
  }
]

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

Unauthorized

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Forbidden

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

500

Internal Server Error

object

Example ^generated

{}

Show Lead List

Parameters

Header Parameters

Responses

200

Example

400

Example generated

401

403

500

Example generated

Example ^generated

Example ^generated