ImmobiNet
ImmobiNet API Docs - Reservations

Retrieve reservations

GET
/api/v1/reservations
basic

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.

Retrieve reservations › query Parameters

updated_since
​string

Returns 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.

Example: 2026-01-31T10:00:00+01:00
arrival_from
​string

Returns only the reservations arriving on or after this day (YYYY-MM-DD, inclusive). An invalid value returns 400.

Example: 2026-07-01
arrival_to
​string

Returns only the reservations arriving on or before this day (YYYY-MM-DD, inclusive). An invalid value, or a value before arrival_from, returns 400.

Example: 2026-07-31
departure_from
​string

Returns only the reservations departing on or after this day (YYYY-MM-DD, inclusive). An invalid value returns 400.

Example: 2026-07-01
departure_to
​string

Returns only the reservations departing on or before this day (YYYY-MM-DD, inclusive). An invalid value, or a value before departure_from, returns 400.

Example: 2026-07-31
property_ids
​integer[] · style: form

Only 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_codes
​string[] · style: form

Only 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_limit
​integer · min: 1 · max: 50

Limit items returned in response. Must be between 1 and 50

Default: 20
next_cursor
​string | null

Retrieve reservations › Responses

Successful response

​object

Retrieve a single reservation

GET
/api/v1/reservations/{reservationId}
basic

Requires the API key scope reservations:read.

Retrieve a single reservation › path Parameters

reservationId
​string · uuid · pattern: [0-9A-Za-z-]+ · required

Retrieve a single reservation › Responses

Reservation found

id
​string · uuid
code
​string | null

Code of the reservation in ImmobiNet (the one shown in the application and given to the customer). null if it has none.

external_code
​string | null

Code of the reservation in an external system (e.g. the OTA confirmation code).

status
​string

deleted 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.

Example: confirmed
updated_at
​string · date-time

Last modification time.

Example: 2026-06-26T14:30:00+02:00
deleted_at
​DatetimeRome | null · date-time

Time the reservation was deleted or cancelled in the application (status is then deleted); null otherwise

Example: 2026-06-26T14:30:00+02:00
property_id
​integer | null
arrival
​string · date
departure
​string · date
contact_id
​integer | null

Id 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.

Example: {"stay":700,"total":760,"down_payment":210,"security_deposit":300}
channel
​string | null

Channel the reservation comes from.

​object | null

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.

Example: {"it":"https://www.example.com/it/area-clienti/3f2c9a1e-0b7d-4c55-9a61-2d8e4b7a1c90?check=0a1b2c3d4e5f","en":"https://www.example.com/en/area-clienti/3f2c9a1e-0b7d-4c55-9a61-2d8e4b7a1c90?check=0a1b2c3d4e5f"}
​object

Custom fields defined by the agency (key → value). Empty object if there are none.