v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Guest

getGuestsByFilter

Returns a list of guests matching the selected parameters ### Group account support

get/getGuestsByFilter

propertyIDsstring

List of property IDs, comma-separated, i.e. 37,345,89

status'cancelled' | 'checked_out' | 'in_house' | 'not_checked_in' required

Current guest status

reservationIDstring

roomIDstring

guestNamestring

checkInFromstring date

Filters guests result to return only guests with check-in date range starting on this date

checkInTostring date

Filters guests result to return only guests with check-in date range ending on this date

checkOutFromstring date

Filters guests result to return only guests with check-out date range starting on this date

checkOutTostring date

Filters guests result to return only guests with check-out date range ending on this date

200 Response

successboolean

Returns if the request could be completed

countinteger

Number of results returned

totalinteger

Total number of results

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.