Search accessible
const url = 'https://api.wink.travel/api/managing-entity/grid';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', '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 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "skip": 0, "take": 30, "sort": "", "filter": "", "group": "" }'Paginated, filterable search across the managing entities you can access (admins see all). Filter by lifecycle state in the request body. Use this to power a ‘select an account to manage’ grid.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”Filter grid by state request body
object
Number of records to be skipped by the pager.
Example
0Number of records to take.
Example
10Descriptors used for sorting result set.
object
Descriptors used for sorting result set
Example
ascData set field to sort on
Example
hotel.nameDescriptors used for filtering result set
object
Whether to filter inclusively or exclusively
Example
andDescriptors used for filtering the result set
object
Field name to filter on
Example
hotel.nameFilter operator to use on field
Example
startsWithValue to filter dataset against
Example
Happy ResMake filter comparison case insensitive. Default: Case sensitive
Example
trueDescriptors to group result sets by.
object
Field to group data set on
Example
createdDateGroup sort direction
Example
ascPrimitive aggregate data points
object
Field to run aggregate function on
Example
hotel.bookingsAggregate function
Example
countResponses
Section titled “ Responses ”OK
object
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
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.
UUID of the user who created/owns this managing entity.
UUID of the application/owner that provisioned this record (typically Wink).
Let users manage this entity and all sub-entities.
object
Email address of the managing entity team member.
Invitation status: PENDING (invite sent, awaiting response), ACCEPTED (active team member).
Unique identifier of the associated user (null until invitation is accepted).
First name of the team member.
Last name of the team member.
Secondary/alternative email address for the team member.
Phone number for contacting the team member.
Profile picture is available
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Account owner
Per-section access grants for object-level ACL
object
Functional area of the platform this grant applies to; ALL is a wildcard that covers every section
Access level (READ < WRITE < FULL); a higher level subsumes all lower ones
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
Entity identifier
Name of entity
Agency commission
Optional rules for expiration date etc when agency is no longer managing this entity.
Owner type: INDIVIDUAL (sole proprietor) or COMPANY (corporate entity).
Entity type: HOTEL, APPLICATION, TRAVEL_AGENT, INFLUENCER, CORPORATE, DESTINATION, CHANNEL_MANAGER, etc.
Display name of the managing entity.
Short description reflecting the entity’s brand and positioning.
Legal/registered name if different from display name.
URL-friendly slug (kebab-case) uniquely identifying the entity in public profiles and links.
Human-friendly unique identifier (shorter than UUID, used in some public contexts).
Primary email address for account communications, KYC documents, and compliance notices.
Primary phone number for KYC verification and account support.
Primary website or social media URL representing the entity.
ISO 4217 primary currency code for accounting and payouts.
Status of entity.
City location
object
GeoName identifier
GeoNameLightweight type
Name of city
Url name
Ascii name of city
Coordinate points of the city
object
Timezone
Country
object
ISO code
Country name
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
Country sub division
object
Sub-country name
Sub-country ascii name
Sub-country GeoNames identifier
Country sub sub division
object
Account address. Usually the business address
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Optional subscription for this entity.
object
Stripe subscription ID returned by Stripe API.
Latest Stripe invoice ID associated with this subscription.
Stripe customer ID (identifies the managing entity in Stripe).
Email address associated with the Stripe customer account.
Phone number associated with the Stripe customer account.
Stripe price lookup key identifying the subscription tier and billing period (e.g. growth_yearly, starter_monthly).
Current subscription status in Stripe (e.g. ACTIVE, PAST_DUE, CANCELED).
Status of the latest invoice for this subscription (e.g. PAID, DRAFT, OPEN).
Time subscription was created
Time subscription was last updated
Time subscription was canceled
Time subscription was last updated
Optional information we receive from Stripe that we want to save.
object
Bank accounts used for payouts.
object
Unique bank account identifier
ISO 3166-1 alpha-2 country code (e.g. US, GB, TH, JP).
ISO 4217 currency code (e.g. USD, EUR, THB).
Name of the bank account holder.
Bank SWIFT code (BIC), uniquely identifying the bank and branch.
Bank account routing number (US), sort code (UK/HK), or Zengin code (JP).
Bank account number or IBAN. In all EU countries, this is the IBAN; in other countries, the routing number also applies.
Recipient bank account address. Optional; recommended by Revolut and required by some payout corridors.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Revolut counterparty ID assigned after the first successful payout is initiated. Null until first Revolut payout.
Revolut revtag payout destinations.
object
Unique identifier for this payout destination.
Revolut profile type: PERSONAL (individual account) or BUSINESS (business/enterprise account).
Full legal name of the Revolut account holder (must match the Revolut profile name exactly).
Revolut username/tag (without the leading ’@’ symbol).
ISO 4217 currency code for payouts to this account (e.g. EUR, USD, GBP).
Cached Revolut counterparty ID (assigned after first successful payout). Null only during initial creation before counterparty is established.
Customize account with a custom profile picture.
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Entity logo
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether the managing entity has consented to have their logo and images used for Wink marketing (with proper attribution).
Optional Google placeId for properties with a Google Business account.
Online presence of account.
object
List of all active accounts that could be used for selling or seeing a company’s reach.
The url, account name or phone number that identifies this user with the specified network.
The type of audience you have on this network.
The size of your audience.
How you would like to order your accounts.
Whether to disable this entry temporarily.
Travel agent details
object
Whether the agent is in charge of charging the property.
Whether the agent is in charge of paying the property.
object
Entity ID should be the same as parent but can be different.
Type of entity (e.g. PROPERTY, AFFILIATE, PAYMENT).
object
object
object
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": "", "logo": "", "marketingOptinAllowed": false, "placeId": "", "onlinePresence": [ "" ], "travelAgent": "", "accounts": [ { "identifier": "", "type": "AFFILIATE" } ] } ]}Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}