Sign in

v1

latestOpenAPI 3.0.32026-07-2672165314.6 KB
Reservations

Booking by id

get/v2/reservations/bookings/{id}

Path parameters

idinteger required

Id of the Booking

Response

OK

idinteger

Id of the booking

user_idinteger

User the booking belongs to

arrivalstring

Arrival date

departurestring

Departure date

property_idinteger

Id of the property

languagestring nullable

Language selected by the guest

status'Open' | 'Tentative' | 'Booked' | 'Declined'

Status information of the Booking

is_unavailableboolean

Booking cannot be booked because calendar is not available

is_overbookedboolean

Booking is overbooked

tentative_expires_atstring date-time nullable

Time the Tentative status will expire at

source'Manual' | 'OH' | 'NineFlats' | 'Airbnb' | 'AirbnbIntegration' | 'HomeAway' | 'BookingCom' | 'Expedia' | 'ICal' | 'Email' | 'FacebookMessenger' | 'PublicApi' | 'Other'

Type of source the Booking comes from

source_textstring nullable

Details of the booking from the source

created_from_ipstring nullable

Ip the booking was created from

created_atstring date-time

Time the booking was created at

updated_atstring date-time

Last time the booking was updated

canceled_atstring date-time nullable

Date the booking was canceled at

is_newboolean

When it is new, the owner has not seen the booking yet

is_deletedboolean

When it is deleted, the owner moved the booking to trash

currency_codestring nullable

Currency in which all amounts are expressed for this booking

total_amountLodgifyAppTypesMoney1
amount_paidLodgifyAppTypesMoney1
amount_dueLodgifyAppTypesMoney1
notesstring nullable

Notes added by the owner

thread_uidstring uuid

Uid of the message thread the booking belongs to

external_bookingstring nullable

Booking information as received from an external channel

upgraded_enquiry_idinteger nullable

If the booking was upgraded from an enquiry, this is the Id of the original enquiry.