Reservations
List of bookings
Retrieve a list of bookings matching the query parameters
get/v2/reservations/bookings
Request
- Base URLhttps://api.lodgify.com
- AuthAPI key in header X-ApiKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageinteger
Number of the page to retrieve
sizeinteger
Number of items per page
includeCountboolean
Include number of all items
stayFilter'Upcoming' | 'Current' | 'Historic' | 'All' | 'ArrivalDate' | 'DepartureDate'
Filter Bookings by the stay dates
updatedSincestring date-time
Include only Bookings updated since this date
includeTransactionsboolean
Include details about transactions and schedule
includeExternalboolean
includeQuoteDetailsboolean
Include quote details
trash'False' | 'True' | 'All'
Query bookings that are in trash
stayFilterDatestring date-time
Date to filter when selected ArrivalDate or DepartureDate in stayFilter
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.