Reservations List

get

Retrieve a list of reservations filtered by date type and a date range via fromDate & toDate. Max duration is 31 days. Only confirmed and cancelled reservations are returned.

Query parameters
dateTypestring · enumRequired

The type of date to filter reservations by.

Possible values:
fromDatestring · dateRequired

The start date of the date range (inclusive). Cannot be more than 365 days in the past.

toDatestring · dateRequired

The end date of the date range (inclusive).

pageinteger · min: 1Optional

The page number of the results to fetch.

Default: 1
perPageinteger · min: 1 · max: 200Optional

The number of results per page.

Default: 100
Header parameters
x-sm-api-idstringRequired

The api id for channel

x-sm-api-keystringRequired

The api key for channel

Responses
200
Successful response. Returns a list of reservations.
application/json
get
GET /reservations?dateType=checkIn&fromDate=2025-07-04&toDate=2025-07-04 HTTP/1.1
Host: 
x-sm-api-id: text
x-sm-api-key: text
Accept: */*
[
  {
    "bookingReferenceId": "text",
    "propertyUuid": "text",
    "bookedOnDate": "2025-07-04",
    "checkInDate": "2025-07-04",
    "checkOutDate": "2025-07-04",
    "currencyCode": "text",
    "paymentTotal": 1,
    "status": "Confirmed",
    "channelCommissionAmount": 1
  }
]

Last updated

Was this helpful?