getReservationsWithRateDetails

get

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

Returns a list of reservations with added information regarding booked rates and sources.
Please note that some reservations modification may not be reflected in this timestamp.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

propertyID

string

Property ID

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. If it is not set, will return the reservations up to current date

modifiedFrom

date-time

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

modifiedTo

date-time

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

sortByRecent

boolean

Sort response results by most recent action

reservationID

string

Reservation identifiers, comma-separated, i.e. 37,345,89, used to return transactions limited to the selected reservations.

reservationCheckOutFrom

date

Superior limit datetime, used to filter reservations, based on reservation check-out date.

reservationCheckOutTo

date

Superior limit datetime, used to filter reservations, based on reservation check-out date.

includeDeleted

boolean

Defaults to false

Include deleted reservations

excludeStatuses

string

List of statuses (separated by comma) to be excluded from search

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

guestID

string

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

pageNumber

integer

Defaults to 1

Results page number

pageSize

integer

Defaults to 100

Results page size. Max = 100

Response

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 Response