Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Reservations Reports Open Api [Beta]

Get reservations report by view id

Retrieves a report of reservations based on the view ID

get/reservations-reports/{viewId}

Path parameters

viewIdstring required
Example:67b5d6155383c8aa4cfecd0d

The ID of the view to get the report for

Query parameters

limitnumber

The maximum number of results to return

skipnumber

The number of results to skip

timezonestring required
Example:Asia/Jerusalem

The timezone to use for the report. Select the relevant entry from this list

Response

Success

resultsstring[] required
totalnumber required
limitnumber required
skipnumber required
viewIdstring required

Example response

{
  "results": [
    {
      "_id": "67ab1fc34f984e5db903ff65",
      "accountId": "5ca6f23b36222c1886bbca94",
      "checkIn": "2025-02-25 05:00 PM",
      "checkOut": "2025-02-27 12:00 PM",
      "confirmationCode": "GY-zuGNvW8a",
      "guest": {
        "name": "Arnold Guest",
        "withAvatar": false
      },
      "listing": {
        "img": "https://assets.guesty.com/image/upload/example.jpg",
        "name": "My Listing",
        "withAvatar": true
      },
      "listingId": "65b7a04dfb984a0010ef6504",
      "status": "confirmed",
      "timezone": "America/Chicago"
    }
  ]
}