Skip to content

Show Profile

GET
/api/profile
curl --request GET \
--url https://api.wink.travel/api/profile \
--header 'Wink-Version: 2.0'

Show profile by profile owner.

Wink-Version
string
default: 2.0.0
Allowed values: 2.0

OK

Media type application/json
object
id

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
""
userIdentifier
required

User identifier

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

Indicates whether the user wants to share this profile of themselves with hotel(s)

boolean
user
required

User details

object
firstName

First name

string
""
lastName

Last name

string
""
email

Email

string format: email
""
phone

Telephone

string
""
profilePictureUrl

Profile picture URL

string
""
fullName

Full name

string
""
personal
required

Detailed customer information for this profile

object
gender

Identifier the gender of the customer.

string
""
Allowed values: MALE FEMALE OTHER
birthDate

Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.

string format: date
""
maritalStatus

Marital status of the traveler.

string
""
Allowed values: ANNULLED COHABITATING DIVORCED ENGAGED MARRIED SEPARATED SINGLE WIDOWED UNKNOWN
childQuantity

The number of children of the customer.

integer format: int32
""
citizenship

Name of the (self-professed) country that is clamided for citizenship.

string
""
address1

Address line 1

string
""
address2

Address line 2

string
""
city

City

string
""
state

State

string
""
postalCode

Postal code

string
""
country

Country

string
""
preferredCurrency

Type of funds preferred for reviewing monetary values, in ISO 4217 codes

string
""
language

The primary language of the customer

string
""
contactPerson
Array<object>

Array of emergency contact information for the customer

object
firstName

Contact first name

string
""
lastName

Contact last name

string
""
email

Contact E-mail

string format: email
""
secondaryEmail

Contact secondary Email

string
""
phoneNumber

Contact phone number

string
""
fullName

First and last name

string
""
summary

Summary

string
""
physChallName
Array<string>
petInfo
Array<object>

Array of customer’s pets

object
name
required

Pet name

string
"" >= 1 characters
type
required

Pet type

string
"" >= 1 characters
preferences
required

Customer preferences

object
propertyLocationPref

Indicates preference for hotel property locations.

string
""
propertyTypePref

Indicates preference for hotel property types.

string
""
hotelChainPref

Identifies a preferred company by name.

string
""
propertyAmenityPref

Indicates preferences for hotel property amenities.

Array<string>
recreationSrvcPref

Indicates preference for the type of recreation services in a hotel

Array<string>
businessSrvcPref

Indicates preference for type of business services in a hotel

Array<string>
securityFeaturePref

Indicates preference of rtype of security features in a hotel

Array<string>
physChalFeaturePref

Indicates preferences for type of features required to meet the needs of persons with physical challenges, disabilities, etc.

Array<string>
""
smokingAllowed

Indicates preference for smooking allowed rooms..

boolean
roomLocationPref

Indicates preference for hotel room locations.

string
""
bedTypePref

Indicates preferences for the size and features of hotel bed types.

string
""
foodSrvcPref

Indicates preferences for type of food listener facilities in a hotel.

string
""
roomAmenityPref

Indicates preferences for hotel room amenities.

Array<string>
guestType

Guest type

string
""
mealPref

Indicates meal preference.

string
""
cuisinePref

Indicates cuisine preference.

string
""
interestPref

Indicates interest preference

Array<string>
beveragePref

Indicates beverage preference.

Array<string>
foodPref

Indicates food preference.

Array<string>
allergies

Indicates allergies

Array<string>
petsPref

Indicates pet preferences

Array<string>
Example
{
"id": "",
"createdDate": "",
"lastUpdate": "",
"version": "",
"userIdentifier": "",
"share": false,
"user": "",
"personal": "",
"preferences": ""
}

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

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

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

Internal Server Error

object
Example generated
{}