Get bookings report with filters and pagination

Returns a paginated bookings/reservations report for the account. Supports date range filters (booked date or check-in date), listing-level filters, and various portfolio filters such as tags, groups, cities, bedroom count, and sync status.

At least one date filter group is recommended. If no date filters are provided, defaults to bookings from the last 90 days.

Headers

X-API-KeystringRequired

Request

This endpoint expects an object.
date_filtersobjectOptional

Date range filters. Provide either booked date range or check-in date range (or both).

filtersobjectOptional
Listing and booking filters.
limitintegerOptional1-500Defaults to 200

Maximum number of rows to return (1-500). Defaults to 200.

offsetintegerOptional>=0Defaults to 0
Number of rows to skip for pagination. Defaults to 0.

Response

Bookings report data with pagination
dataobjectOptional

Errors

400
Bad Request Error
502
Bad Gateway Error