latestOpenAPI 3.0.32026-08-10508390.8 KB

51c85bc66c44

Finds reservations based on the provided criteria.

get/rest/v1/reservations

Query parameters

'DESK'
OR
'ROOM'
locationIdsID[]
floorIdsID[]
neighborhoodIdsID[]
userIdsID[]
startDatestring date

A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

endDatestring date

A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

startTimestring date-time

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

endTimestring date-time

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

'PENDING'

A reservation is pending when the start time is in the future.

OR
'ACTIVE'

A reservation is active when the start time is in the past and the end time is in the future, and when there is no checkout time.

OR
'COMPLETED'

A reservation is completed when there is a checkout for this reservation, or the reservation end time is in the past.

OR
'CANCELED'

A reservation is canceled when there is no checkout or checkin but there is a canceled at time.

emailsString[]
pagenumber

Integers that will have a value greater than 0.

perPagenumber

Integers that will have a value greater than 0.

Response

[Reservation!]!