Reservations
Retrieve reservations
Returns a paginated list of the reservations visible to the API user, ordered by updated_at and id ascending. Requires the API key scope reservations:read.
query Parameters
updated_sinceReturns only the items modified at or after this instant. ISO 8601 date-time with an explicit offset (e.g. 2026-01-31T10:00:00+01:00 or 2026-01-31T09:00:00Z; URL-encode the + as %2B). It cannot be in the future: an invalid or future value returns 400.
arrival_fromReturns only the reservations arriving on or after this day (YYYY-MM-DD, inclusive). An invalid value returns 400.
arrival_toReturns only the reservations arriving on or before this day (YYYY-MM-DD, inclusive). An invalid value, or a value before arrival_from, returns 400.
departure_fromReturns only the reservations departing on or after this day (YYYY-MM-DD, inclusive). An invalid value returns 400.
departure_toReturns only the reservations departing on or before this day (YYYY-MM-DD, inclusive). An invalid value, or a value before departure_from, returns 400.
property_idsOnly the reservations of these properties (ids, the property_id of the reservation), comma-separated (property_ids=12,15). Together with property_codes at most 50 values, more returns 400. A property that is not visible to the API user gives no reservations.
property_codesOnly the reservations of the properties with these codes (the code of /api/v1/properties; exact match, case-insensitive), comma-separated (property_codes=A1,B2). Together with property_ids at most 50 values. With both, a reservation of a property matching either is returned. The code is a filter, not an identifier: use property_id to refer to a property. No match gives an empty list.
paging_limitLimit items returned in response. Must be between 1 and 50
next_cursorRetrieve reservations › Responses
Successful response
Retrieve a single reservation
Requires the API key scope reservations:read.
path Parameters
reservationId[0-9A-Za-z-]+ · requiredRetrieve a single reservation › Responses
Reservation found
idcodeCode of the reservation in ImmobiNet (the one shown in the application and given to the customer). null if it has none.
external_codeCode of the reservation in an external system (e.g. the OTA confirmation code).
statusdeleted when deleted_at is set, whatever the status: this is the case of every reservation deleted or
cancelled in the application (cancelled, cancelled with a penalty, turned into an owner hold, to be
handled). Otherwise the status of the reservation:
awaiting_down_payment, confirmed, checked_in, checked_out, handled (managed by a channel). The values
cancelled, reversed (cancelled with a penalty), owner_hold (turned into a hold of the owner) and
to_be_handled (received from a channel, not yet handled) appear only for some reservations received from a channel,
which have no deleted_at.
A status defined by the agency and not listed here is returned with its own name: treat unknown values as
valid.
updated_atLast modification time.
deleted_atTime the reservation was deleted or cancelled in the application (status is then deleted); null otherwise
property_idarrivaldeparturecontact_idId of the customer's contact (see /api/v1/contacts); null if the customer has no contact (only a typed name, which the API does not expose). Name, email and the other data of the customer are in the contact.
Amounts in euro.
channelChannel the reservation comes from.
Links to the guest area of the reservation, one for each language of the installation: the key is the language code (as language of the contacts, e.g. it, en), the value the link in that language. Pick the one of the guest's language (customer → /contacts/{id} → language). The whole field is null if the guest area is not available, the reservation is deleted (deleted_at set) or the guest area cannot be opened for it (e.g. access blocked after arrival or departure), or if the API user cannot see customers' personal data (anagrafica_personale_tutti privilege), because the link opens the customer's full data (it is null even when the customer's name is shown). The guest area can stop being accessible over time (access blocked after arrival or departure) without the reservation changing, so a link read earlier may no longer work and updated_since does not report it. Read it when needed, do not store it.
Custom fields defined by the agency (key → value). Empty object if there are none.

