tagsstring[]
A collection of tag names.
arrivalstring date
Arrival date in property time zone.
booked_utcstring date-time nullable
canceled_utcstring date-time nullable
cancellation_policy_descriptionstring
cancellation_policy_idinteger nullable
check_instring
Check-in time in property time zone in 24 hour HH:mm format, e.g. 16:00.
check_in_endstring
Check-in end time in property time zone in 24 hour HH:mm format, e.g. 21:00 (optional).
check_outstring
Check-out time in property time zone in 24 hour HH:mm format, e.g. 09:00.
cleaning_datestring date-time nullable
Scheduled cleaning date and time in property time zone.
created_utcstring date-time
The date this booking was created in the system.
departurestring date
Departure date in property time zone.
form_keystring
Public form key for reference in guest form URL's.
is_blockboolean
Deprecated: use type instead. If this booking is a simple blocked-off time booking (true), or a full guest booking (false).
listing_sitestring
The name of the listing site this booking is attributed to.
listing_site_idinteger nullable
The Id of the listing site this booking is attributed to. Use the Id from the listing sites endpoints.
pending_until_utcstring date-time nullable
platform_email_addressstring
A proxy email address provided by the OTA specifically for this booking.
platform_phone_numberstring
A temporary phone number provided by the OTA specifically for this booking. Null after midnight in the property's time zone 2 days after departure, or when the booking is canceled.
platform_reservation_numberstring
The OTA reservation number, if applicable.
status'active' | 'canceled' | 'pending'
thread_idsinteger[]
Message threads for this booking. Read a thread's messages with GET /v2/messages?threadId={id}.
total_amountnumber nullable
total_host_feesnumber nullable
total_owednumber nullable
total_paidnumber nullable
total_refundednumber nullable
type'booking' | 'block' | 'quote_hold' | 'linked_availability' | 'owner'
updated_utcstring date-time nullable
The date this booking was last updated in the system.