v1
latestOpenAPI 3.0.02026-07-247251950.2 KBRetrieve all bookings
Overview
Get all bookings associated with your API key, with optional filtering by date ranges. Perfect for generating reports and managing your booking inventory.
When to Use
- Booking reports - Generate reports of all bookings
- Date range queries - Find bookings within specific date ranges
- Administrative overview - View all bookings in your system
- Analytics - Analyze booking patterns and trends
What You Get
- Complete booking list - All bookings linked to your API key
- Filtered results - Optional filtering by stay dates or booking creation dates
- Booking details - Full information for each booking
- Status information - Current status of each booking
Filtering Options
- Stay period - Filter by check-in/check-out date range (startDate, endDate)
- Booking period - Filter by when bookings were created (bookingStartDate, bookingEndDate)
- Status - Filter by booking status (optional)
Quick Start
No parameters required for all bookings. Optionally provide date ranges to filter results. Returns all matching bookings with complete details.
Query parameters
Start date of the stay period. Returns bookings where the stay (check-in to check-out) overlaps with this date range.
End date of the stay period. Returns bookings where the stay (check-in to check-out) overlaps with this date range.
Start date of the booking creation period. Only bookings that were created on or after this date will be included.
End date of the booking creation period. Only bookings that were created on or before this date will be included.
Status of the bookings.
Filter by payment status.
Indicates if the request was made in a sandbox (test) environment
Filter by customTags. Comma-separated KEY:VALUE pairs (e.g. SOURCE:GOOGLE,TIER:GOLD); all pairs are joined with AND. Keys must match ^[A-Z0-9_-]+$, up to 5 keys, value up to 255 characters. Value matching is case-insensitive.
Response
The total number of bookings retrieved