List property reviews

POST

/api/managing-entity/{managingEntityIdentifier}/extranet/review/grid

const url = 'https://api.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/review/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/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/review/grid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "skip": 0, "take": 30, "sort": "", "filter": "", "group": "" }'

Returns a paginated, filterable grid of guest reviews for the property, including filters by date, guest name, rating, and approval status.

Authorizations

oauth2ClientCredentials

Parameters

Path Parameters

managingEntityIdentifier

required

string

Property identifier to show reviews for

Example

e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

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

Paginated list of reviews retrieved successfully

application/json

object

totalPages

integer format: int32

totalElements

integer format: int64

size

integer format: int32

content

Array<object>

object

Document UUID

string format: uuid

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

bookingIdentifier

Booking identifier this review is associated with.

string format: uuid

hotelIdentifier

Property (hotel) identifier this review is for.

string format: uuid

user

Guest who submitted the review.

object

userIdentifier

User identifier

string format: uuid

firstName

Guest’s first name.

string

lastName

Guest’s last name.

string

email

Guest’s email address.

string format: email

telephone

Guest’s phone number.

string

fullName

Guest’s full name.

string

reviewDate

Date and time the review was submitted.

string format: date-time

averageScore

Average rating across all question answers (0-10 scale).

number format: double

answers

Guest’s answers to each review question with their scores.

Array<object>

object

questionIdentifier

required

Review question identifier that this answer responds to.

string format: uuid

"" >= 1 characters

category

required

Category of the question (e.g., COMFORT, SERVICE, VALUE).

string

Allowed values: COMFORT CONDITION SERVICE ENVIRONMENT FACILITIES LOCATION LIFESTYLE VALUE FOOD ROOM

sort

required

Display order of this answer within the review.

integer format: int32

value

required

Guest’s numeric rating for this question on a 0-10 scale.

integer format: int32

messageFromGuest

Private feedback message from guest to hotel manager. Not publicly displayed.

string

responseFromHotel

Hotel’s public response to the guest review.

string

imageIdentifier

Cloudinary image identifier for guest’s photo from their stay.

string

text

Guest’s written review text.

string

approvedText

Hotel has approved this review text for public display on their profile.

boolean

approvedImage

Hotel has approved the guest’s photo for public display on their profile.

boolean

likes

User identifiers who ‘liked’ this review.

Array<string>

roomNumber

Guest’s room number during their stay.

string

roomRating

Guest’s personal rating of their room on a 0-10 scale.

integer format: int32

responded

Hotel has submitted a response to this review.

boolean

number

integer format: int32

first

boolean

last

boolean

numberOfElements

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageable

object

offset

integer format: int64

pageNumber

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageSize

integer format: int32

paged

boolean

unpaged

boolean

empty

boolean

Example

{
  "content": [
    {
      "id": "",
      "createdDate": "",
      "lastUpdate": "",
      "version": "",
      "bookingIdentifier": "",
      "hotelIdentifier": "",
      "user": "",
      "reviewDate": "",
      "averageScore": "",
      "answers": [
        ""
      ],
      "messageFromGuest": "",
      "responseFromHotel": "",
      "imageIdentifier": "",
      "text": "",
      "approvedText": false,
      "approvedImage": false,
      "likes": [
        ""
      ],
      "roomNumber": "",
      "roomRating": "",
      "responded": false
    }
  ]
}

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

Not authenticated

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Not authorized to access this property’s reviews

*/*

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

{}

List property reviews

Authorizations

Parameters

Path Parameters

Example

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