Search Managing Entities

POST

/api/managing-entity/grid

const url = 'https://api.wink.travel/api/managing-entity/grid';
const options = {
  method: 'POST',
  headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'},
  body: '{"skip":0,"take":30,"sort":"","filter":"","group":""}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.wink.travel/api/managing-entity/grid \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "skip": 0, "take": 30, "sort": "", "filter": "", "group": "" }'

Retrieve a paginated list of entities that you manage.

Parameters

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

Filter grid by state request body

application/json

object

skip

Number of records to be skipped by the pager.

integer format: int32

Example

take

Number of records to take.

integer format: int32

default: 30 >= 1 <= 180

Example

sort

Descriptors used for sorting result set.

Array<object>

object

dir

Descriptors used for sorting result set

string

Allowed values: asc desc

Example

asc

field

Data set field to sort on

string

Example

hotel.name

filter

Descriptors used for filtering result set

object

logic

Whether to filter inclusively or exclusively

string

Allowed values: and or

Example

and

filters

Descriptors used for filtering the result set

Array<object>

object

field

required

Field name to filter on

string

"" >= 1 characters

Example

hotel.name

operator

required

Filter operator to use on field

string

Allowed values: neq eq contains doesnotcontain isnull isnotnull isempty isnotempty startswith endswith gte lte gt lt in nin

Example

startsWith

value

Value to filter dataset against

Example

Happy Res

ignoreCase

Make filter comparison case insensitive. Default: Case sensitive

boolean

Example

true

group

Descriptors to group result sets by.

Array<object>

object

field

Field to group data set on

string

Example

createdDate

dir

Group sort direction

string

Allowed values: asc desc

Example

asc

aggregates

Primitive aggregate data points

Array<object>

object

field

Field to run aggregate function on

string

Example

hotel.bookings

aggregate

Aggregate function

string

Allowed values: count sum average min max

Example

count

Responses

200

application/json

object

totalPages

integer format: int32

totalElements

integer format: int64

size

integer format: int32

content

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

userIdentifier

required

User owner.

string

"" >= 1 characters

ownerIdentifier

required

The App owner that created this record.

string

"" >= 1 characters

managers

required

Array<object>

0 <= 30 items

Let users manage this entity and all sub-entities.

object

email

required

User email

string format: email

"" >= 1 characters

status

Contact phone number

string

Allowed values: PENDING ACCEPTED DEACTIVATED

userIdentifier

User identifier

string format: uuid

firstName

Contact first name

string

lastName

Contact last name

string

secondaryEmail

Contact secondary Email

string

phoneNumber

Contact phone number

string

profilePicture

Profile picture is available

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

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

owner

Account owner

boolean

sectionGrants

Array<object>

Per-section access grants for object-level ACL

object

section

required

The area this grant applies to (ALL covers every section)

string

Allowed values: ALL ACCOUNT INVENTORY BOOKING MARKETING CONTENT ANALYTICS INTEGRATIONS MCP PAYMENT ACCOUNTING USER_ADMIN ADMIN

level

required

How much the manager may do within that area

string

Allowed values: READ WRITE FULL

name

string

active

boolean

managedBy

If another company entity is managing this property, on behalf of the property, it can be specified here and the managing entity would be applicable a management fee on every booking.

object

identifier

required

Entity identifier

string

"" >= 1 characters

name

required

Name of entity

string

"" >= 1 characters

commissionInPercent

required

Agency commission

number

rules

Optional rules for expiration date etc when agency is no longer managing this entity.

ownerType

required

Type of entity this is.

string

Allowed values: COMPANY INDIVIDUAL

type

required

Type of sales channel

string

Allowed values: TRIP_PAY FACILITATOR DIRECT APPLICATION HOTEL TRAVELIKO CORPORATE TRAVEL_AGENT INFLUENCER BLOGGER DESTINATION CHANNEL_MANAGER PROPERTY_MANAGEMENT_SYSTEM CENTRAL_RESERVATION_SYSTEM GOOGLE_HOTEL_API MANAGEMENT_COMPANY CHAIN BRAND EVENT_ORGANIZER OTHER

name

required

Text representation of the value.

string

"" >= 1 characters

description

required

Short company / person description.

string

"" >= 1 characters

legalName

required

Legal name of entity if other than name

string

"" >= 1 characters

urlName

required

Unique url-friendly slug to identify property

string

"" >= 1 characters

uniqueId

required

Event shorter name

string

"" >= 1 characters

accountEmail

required

Account email is where we will send KYC documents and other account specific mailings

string format: email

"" >= 1 characters

accountPhoneNumber

required

Account phone number is mostly used for KYC purchases

string

"" >= 1 characters

url

required

AffiliateAccount website. If private person with no personal website, link to main social network account.

string

"" >= 1 characters

currencyCode

required

Account’s main currency.

string

"" >= 1 characters

status

required

Status of entity.

string

Allowed values: PENDING_APPROVAL ACTIVE INACTIVE UNDER_REVIEW SUSPENDED REJECTED REMOVED

city

required

City location

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

address

Account address. Usually the business address

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

plan

Optional subscription for this entity.

object

subscriptionId

required

Stripe subscription ID

string

"" >= 1 characters

invoiceId

required

Latest Stripe invoice ID

string

"" >= 1 characters

customerId

required

Stripe customer ID

string

"" >= 1 characters

customerEmail

required

Stripe customer ID

string

"" >= 1 characters

customerPhone

required

Stripe customer ID

string

"" >= 1 characters

priceLookupKey

required

Stripe price lookup key

string

Allowed values: CREATOR_FREE CREATOR_MONTHLY CREATOR_YEARLY STARTER_FREE STARTER_MONTHLY STARTER_YEARLY GROWTH_FREE GROWTH_MONTHLY GROWTH_YEARLY ELITE_FREE ELITE_MONTHLY ELITE_YEARLY ENTERPRISE

status

required

Stripe subscription status

string

Allowed values: ACTIVE CANCELED INCOMPLETE INCOMPLETE_EXPIRED PAST_DUE PAUSED TRIALING UNPAID

invoiceStatus

required

Stripe latest invoice status

string

Allowed values: DRAFT OPEN PAID UNCOLLECTIBLE VOID

createdAt

required

Time subscription was created

string format: date-time

updatedAt

required

Time subscription was last updated

string format: date-time

canceledAt

required

Time subscription was canceled

string format: date-time

trialExpires

required

Time subscription was last updated

string format: date-time

metadata

Optional information we receive from Stripe that we want to save.

object

key

additional properties

string

active

boolean

bankAccounts

Array<object>

Bank accounts used for payouts.

object

identifier

required

Unique bank account identifier

string format: uuid

"" >= 1 characters

countryCode

required

Country of bank account

string

"" >= 1 characters

currencyCode

required

Currency of bank account

string

"" >= 1 characters

accountHolderName

required

Bank account holder name

string

"" >= 1 characters

swiftCode

Bank SWIFT code. Unique code identifier the bank and branch of the bank account.

string

routingNumber

Bank account routing number. This is sort code in HK and Zengin code in JP.

string

accountNumber

required

Bank account number. In all EU countries, this would be the IBAN. In other countries, the routing number will apply as well.

string

"" >= 1 characters

address

Recipient bank account address. Optional; recommended by Revolut and required by some payout corridors.

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

revolutCounterpartyId

Revolut counterparty ID assigned when the first payout is initiated. Null until first Revolut payout.

string | null

revolutPayoutAccounts

Array<object>

Revolut revtag payout destinations.

object

identifier

required

Unique identifier for this destination

string format: uuid

"" >= 1 characters

profileType

required

Whether the recipient’s Revolut profile is personal or business

string

Allowed values: personal business

accountHolderName

required

Recipient’s name; must match the Revolut profile name

string

"" >= 1 characters

revtag

required

Revtag without leading ’@’

string

"" >= 1 characters

currencyCode

required

Currency of the payout

string

"" >= 1 characters

revolutCounterpartyId

Cached Revolut counterparty ID populated at upsert time. Null only during the in-memory window before counterparty creation succeeds.

string | null

profilePicture

Customize account with a custom profile picture.

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

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

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

logo

Entity logo

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

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

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

marketingOptinAllowed

Account agrees to let us use theor logo and images for marketing purposes (with proper credits).

boolean

placeId

Optional Google placeId for properties with a Google Business account.

string

onlinePresence

Array<object>

Online presence of account.

object

type

required

List of all active accounts that could be used for selling or seeing a company’s reach.

string

Allowed values: WINK WEB_SITE PERSONAL_WEB_SITE CORPORATE_WEB_SITE FACEBOOK INSTAGRAM TWITTER_X LINKEDIN TIKTOK SNAPCHAT MASTODON THREADS HIVE_SOCIAL MEWE ELLO WHATSAPP TELEGRAM SIGNAL WECHAT LINE KAKAOTALK VIBER DISCORD SKYPE FACEBOOK_MESSENGER YOUTUBE TWITCH BILIBILI VIMEO DAILYMOTION KICK UPLIVE PINTEREST BEREAL VSCO IMGUR FLICKR FIVE_HUNDRED_PX REDDIT QUORA TUMBLR PLURK MEDIUM BLUESKY MINDS STEEMIT DIASPORA WHISPER YIK_YAK TELLONYM GOOGLE GITHUB SPOTIFY UPWORK SHOPIFY AMAZON PERSONAL_EMAIL WORK_EMAIL ONLY_FANS FANSLY

identifier

required

The url, account name or phone number that identifies this user with the specified network.

string

"" >= 1 characters

audiences

The type of audience you have on this network.

Array<string>

Allowed values: EVERYONE ADVENTURE BEACH BUSINESS CULTURAL_EXPERIENCE EDUCATION FAMILY FOOD_AND_CULINARY HIKING HISTORICAL_SITES HONEYMOON LUXURY MEDICAL_TOURISM MUSIC_AND_FESTIVALS NATURE_AND_WILDLIFE PHOTOGRAPHY PILGRIMAGE RELAXATION ROAD_TRIP ROMANCE SHOPPING SKIING SOLO_TRAVEL SPORTS_EVENTS VOLUNTEERING WELLNESS_AND_SPA CITY WILDLIFE

audienceSize

The size of your audience.

integer format: int64

sort

How you would like to order your accounts.

integer format: int32

disabled

Whether to disable this entry temporarily.

boolean

travelAgent

Travel agent details

object

selfAcquires

required

Whether the agent is in charge of charging the property.

boolean

selfDisburses

required

Whether the agent is in charge of paying the property.

boolean

verified

boolean

accounts

Array<object>

object

identifier

required

Entity ID should be the same as parent but can be different.

string

"" >= 1 characters

type

required

Type of entity.

string

Allowed values: AFFILIATE PROPERTY PAYMENT

number

integer format: int32

numberOfElements

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

first

boolean

last

boolean

pageable

object

offset

integer format: int64

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageSize

integer format: int32

paged

boolean

pageNumber

integer format: int32

unpaged

boolean

empty

boolean

Example

{
  "content": [
    {
      "id": "",
      "createdDate": "",
      "lastUpdate": "",
      "version": "",
      "userIdentifier": "",
      "ownerIdentifier": "",
      "managers": [
        ""
      ],
      "managedBy": "",
      "ownerType": "COMPANY",
      "type": "TRIP_PAY",
      "name": "",
      "description": "",
      "legalName": "",
      "urlName": "",
      "uniqueId": "",
      "accountEmail": "",
      "accountPhoneNumber": "",
      "url": "",
      "currencyCode": "",
      "status": "PENDING_APPROVAL",
      "city": "",
      "address": "",
      "plan": "",
      "bankAccounts": [
        ""
      ],
      "revolutPayoutAccounts": [
        ""
      ],
      "profilePicture": null,
      "logo": null,
      "marketingOptinAllowed": false,
      "placeId": "",
      "onlinePresence": [
        ""
      ],
      "travelAgent": "",
      "accounts": [
        {
          "identifier": "",
          "type": "AFFILIATE"
        }
      ]
    }
  ]
}

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

{}

Search Managing Entities

Parameters

Header Parameters

Request Body required

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

200

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated