v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Guest

getGuestsModified

Returns a list of guests based on their modification date. Note that when a guest checks in or checks out of a room, their record is modified at that time. If no date range is passed, only the records for the current day are returned. Also note that if the guest is assigned to multiple rooms, it will result in multiple records. ### Group account support

get/getGuestsModified

Query parameters

propertyIDsstring

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

inHouseboolean

When used, and true, will return guests only currently in-house. If the guest checks-out, it will not appear on the results.

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

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

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.