getReservations

get

https://api.cloudbeds.com/api/v1.3/getReservations

Returns a list of reservations that matched the filters criteria.
Please note that some reservations modification may not be reflected in this timestamp. ### Group account support

Query Params

propertyID

string

ID for the properties to be queried (comma-separated, i.e. 37,345,89).
It can be omitted if the API key is single-property, or to get results from all properties on an association.

status

string

enum

Filter by current reservation status

Allowed:

resultsFrom

date-time

Inferior limit datetime, used to filter reservations, based on booking date

resultsTo

date-time

Superior limit datetime, used to filter reservations, based on booking date

modifiedFrom

date-time

Inferior limit datetime, used to filter reservations, based on booking modification date

modifiedTo

date-time

Superior limit datetime, used to filter reservations, based on booking modification date

checkInFrom

date

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

checkInTo

date

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

checkOutFrom

date

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

checkOutTo

date

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

datesQueryMode

string

enum

Defaults to booking

If we should consider the booking's check-in/check-out dates or the start and end dates for the associated rooms.

Allowed:

roomID

string

Filters reservation with the supplied room ID. CheckIn/checkOut dates OR status are required. If dates are provided and span more than one day, more than one reservation can be returned. If roomID supplied, roomName is ignored.

roomName

string

Filters reservation with the supplied room name (customizable by each property). CheckIn/checkOut dates OR status are required. If dates are provided and span more than one day, more than one reservation can be returned.

roomTypeID

string

Filters reservation with the supplied Room Type ID.

includeGuestsDetails

boolean

Defaults to false

If guests details should be included or not

includeGuestRequirements

boolean

Defaults to false

Includes guest requirements data in the response. Requires includeGuestsDetails=true.

includeCustomFields

boolean

Defaults to false

If reservation custom fields should be included or not

includeAllRooms

boolean

Defaults to false

When specified, the response will include an additional rooms field that combines both unassigned and assigned rooms.

sourceId

string

Filters reservation with the supplied source ID.

sourceReservationId

string

Filters reservation with the supplied reservation source ID.

ratePlanId

string

Filters reservation with the supplied rate plan ID.

firstName

string

Filters reservation with the supplied primary guest first name.

lastName

string

Filters reservation with the supplied primary guest last name.

guestID

string

Filters reservation with the supplied Guest ID (Including additional guests).

allotmentBlockCode

string

Filters reservation with the supplied allotment block code.

groupCode

string

Filters reservation with the supplied group code.

sortByRecent

boolean

Sort response results by most recent action

pageNumber

integer

Defaults to 1

Results page number

pageSize

integer

Defaults to 100

Results page size. Max = 100

Response

200200 Response