v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Guest

getGuestList

Returns a list of guests, ordered by modification date ### Group account support

get/getGuestList

Query parameters

propertyIDsstring

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

resultsFromstring date-time

Inferior limit datetime, used to filter guests result, based on latest creation/modification date

resultsTostring date-time

Superior limit datetime, used to filter guests result, based on latest creation/modification date

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

guestFirstNamestring

Filters guests result based on Guest First Name

guestLastNamestring

Filters guests result based on Guest Last Name

guestEmailstring

Filters guests result based on Guest Email

guestPhonestring

Filters guests result based on Guest Phone Number

guestCellPhonestring

Filters guests result based on Guest Cell Phone Number

status'in_progress' | 'confirmed' | 'not_confirmed' | 'canceled' | 'checked_in' | 'checked_out' | 'no_show'

Reservation status <br /> If more than one, send as comma-separated values. i.e. in_progress,confirmed

sortBy'creation' | 'modification'

Sort By parameter

includeGuestInfoboolean

If API response should return with more of Guest's information

excludeSecondaryGuestsboolean

If true, response only returns main guest's

includeGuestRequirementsboolean

Includes guest requirements data in the response

pageNumberinteger

Results page number

pageSizeinteger

Results page size. Max = 100

Response

200 Response

successboolean

Returns if the request could be completed

dataobject

Details for the guest linked to the property (key is the Guest ID)

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.