Residence
idName of the residence to show. Residences are not translated yet, so it has one entry, in Italian (it); more languages will be added when they are. Always present.
codeCode of the residence, always present. It is not guaranteed to be unique, so use id to refer to a residence. Use the codes query parameter of the list to find the residences with a code.
typeCode of the type of the residence, as listed by GET /api/v1/residence-types (which also gives its name). Omitted when the residence has no type.
Address. Every field can be null when it is not set (or not visible to the API user); depending on the resource a field without a value is null or left out of the response.
property_idsIds of the properties of the residence visible to the API user, in ascending order. Always present, empty when none is visible.
Reserved for custom fields (key → value). Custom fields are not available for residences yet, so it is always an empty object.
ResidenceType
codeCode of the residence type, the value of type of the residences (e.g. residence).
nameName of the residence type, to show (e.g. Residence turistico).
Facility
facilityCode of the facility in the catalog GET /api/v1/facilities (e.g. adatto_disabili).
statusWhether the facility is included (included), to be paid for (paid) or not allowed (prohibited).
FacilityItem
codeCode of the facility, the value of facility of the facilities of residences and properties (e.g. adatto_disabili).
Name of the facility to show, one for each language of the installation.
PropertyListItem
idcodeProperty code
Address. Every field can be null when it is not set (or not visible to the API user); depending on the resource a field without a value is null or left out of the response.
residence_idId of the residence this property belongs to, if any
agency_idId of the agency that manages the property, null if none. The agencies of the API user are listed by GET /api/v1/agencies.
Name of the property to show, one for each language it has a title in. Empty if none is set.
registration_numberRegistration number of the property (in Italy, the CIN national identification code). null if not set or not available.
created_atCreation time of the property.
updated_atLast modification time of the property. It changes when the property sheet or its attachments are saved in the application; changes to the rates, the availability or the reservations do not move it.
Custom fields defined by the agency (key → value), only the ones marked "Web" in the application, never the ones marked for internal use. Always present, empty object if there are none.
Property
idcodeProperty code
Address. Every field can be null when it is not set (or not visible to the API user); depending on the resource a field without a value is null or left out of the response.
residence_idId of the residence this property belongs to, if any
agency_idId of the agency that manages the property, null if none. The agencies of the API user are listed by GET /api/v1/agencies.
Name of the property to show, one for each language it has a title in. Empty if none is set.
registration_numberRegistration number of the property (in Italy, the CIN national identification code). null if not set or not available.
created_atCreation time of the property.
updated_atLast modification time of the property. It changes when the property sheet or its attachments are saved in the application; changes to the rates, the availability or the reservations do not move it.
Custom fields defined by the agency (key → value), only the ones marked "Web" in the application, never the ones marked for internal use. Always present, empty object if there are none.
categoryCode of the category of the property, as listed by GET /api/v1/property-categories (which also gives its name and destination).
Rooms of the property. null if not available.
Apartment details. null if not available.
Surface of the property. null if not set.
Energy certificate, only when it has been issued. null otherwise.
Beds and maximum guests of a holiday property. null if not available.
Distances from the points of interest. Empty if there are none.
PropertyCategory
codeCode of the category, the value of category of the properties (e.g. appartamento).
nameName of the category, to show (e.g. Appartamento).
destinationUse of the properties of the category.
PropertyComposition
bathroomsbedroomsroomsbalconiesterracesPropertyApartment
floorDescription of the floor.
elevatorstotal_floorsunit_numberPropertyEnergyCertificate
classperformance_indexEnergy performance index, in kWh/m² per year.
PropertyCapacity
typemax_guestsdouble_bedssingle_bedssofa_bedsbunk_bedsPropertyPointOfInterestDistance
codeCode of the point of interest.
distance_metersDistance of the property from the point of interest, in metres.
TranslatedText
language^[a-z]{2}$Language, as an ISO 639-1 code of two lowercase letters (it, en). It names the language only, with no region.
textAttachment
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · attachment_type="file" · requires: id, mime_type, url | |
| type = object · requires: id, mime_type, url +1 more |
idmime_typeurlattachment_typeFileAttachment
idmime_typeurlattachment_typeImageAttachment
idmime_typeurlattachment_typeImageMetadata
file_sizeFile size in bytes
widthImage width in pixels
heightImage height in pixels

