Properties
Properties (the single bookable units). Descriptions, attachments and facilities of this tag refer to the
unit, not to the residence it belongs to (residence_id, see the Residences tag).
Get list of properties
Returns a paginated list of properties. Fetch a single property
(GET /api/v1/properties/{propertyId}) for full property information.
Requires the API key scope properties:read.
query Parameters
codesOnly the properties with these codes (exact match, case-insensitive), comma-separated (codes=A1,B2). At most 50 values, more returns 400.
residence_idsOnly the properties of these residences (a property that belongs to any of them), comma-separated ids (residence_ids=3,7). At most 50 values, more or an invalid id returns 400.
sort_fieldsort_orderIf sort_field is specified but sort_order is not, the default order is 'asc'
paging_limitLimit items returned in response. Must be between 1 and 50
next_cursorGet list of properties › Responses
Get properties list
Get a property
Requires the API key scope properties:read.
path Parameters
propertyIdGet a property › Responses
Get a 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.
Get descriptions of a property
Requires the API key scope properties:read.
path Parameters
propertyIdGet descriptions of a property › Responses
Get descriptions of a property
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.
textGet all attachments of a property
Requires the API key scope properties:read.
path Parameters
propertyIdquery Parameters
typeOnly the attachments of this type: images (images that are not panoramic), panoramic_images or file (anything that is not an image). Omit to get all of them. Any other value returns 400.
Get all attachments of a property › Responses
Get all attachments of a property
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_typeGet an attachment of a property
Requires the API key scope properties:read.
path Parameters
propertyIdattachmentIdGet an attachment of a property › Responses
Get an attachment of a property
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_typeGet facilities of a property
Requires the API key scope properties:read.
path Parameters
propertyIdGet facilities of a property › Responses
Get facilities of a property
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).

