Sign in

v1

latestOpenAPI 3.0.32026-07-2672165314.6 KB
Reservations

Retrieves the full details of a specific booking.

Returns the full details for a specific Booking identified by its ID.

get/v1/reservation/booking/{id}

Path parameters

idinteger required

The unique identifier of the booking.

Response

OK

idinteger

Booking or Enquiry Identifier

typestring nullable

The type of the record (e.g., "Booking" or "Enquiry").

booking_typestring nullable

Specifies the bookability of this is booking or enquiry.

statusstring nullable

The current status of the booking or enquiry.

sourcestring nullable

The origin source of the booking or enquiry.

source_textstring nullable

The textual description of the source.

arrivalstring nullable

The arrival date in yyyy-MM-dd format.

departurestring nullable

The departure date in yyyy-MM-dd format.

peopleinteger nullable

The total number of guests. This property is deprecated; use TotalGuestBreakdown instead.

property_idinteger nullable

The property Identifier (if any) the booking or enquiry references

property_namestring nullable

The property Name (if any) the booking or enquiry references

created_atstring date-time

Booking / Enquiry creation Datetime

is_repliedboolean

bool value indicating if the booking/enquiry has been replied to the renter

updated_atstring date-time

Last update datetime

is_deletedboolean

Boolean indicating if the booking/enquiry is deleted and stored in the trash

date_deletedstring date-time nullable

If is a deleted booking/enquiry then the datetime of deletion, null otherwise

total_amountnumber double nullable

Total amount of the booking/enquiry

total_paidnumber double

Total amount paid for the booking/enquiry

amount_to_paynumber double nullable

Amount to pay for the booking/enquiry

thread_uidstring uuid

Uid of the message thread the booking belongs to

upgraded_enquiry_idinteger nullable

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

notestring nullable

Admin note about the booking

payment_typestring nullable

(Obsolete. Use payment_website_id instead.) Payment type for this Booking

payment_addressstring nullable

(Obsolete. Use payment_website_id instead.) Payment Address for this Booking

payment_website_idinteger nullable

Id of the website chosen as the payment gateway for this booking.