This API is documented in OpenAPI 3.0 format with a few vendor extensions (prefixed with x-
) for the generated HTML docs. We pledge ourselves to be compliant to the OpenAPI Standard, but due to different interpretations of the standard and different levels of implementation in various tools out there, we can not guarantee that the specification available for download above will work with any specific tool or client generator.
In our experience, there is currently no client generator that supports the full featureset of OpenAPI 3.0, let alone newer versions, and thus we most likely can not support you if you run into any issues due to the use of incompatible generators. We may also decide to update to a newer version of the OpenAPI Standard in the future, which - even without any changes to the API itself - can also lead to further incompatibilities with certain tools if they haven't been updated at that point themselves. For this reason, our recommendation is to implement the API Calls and handle the responses by yourself instead of relying on generated code.
This API does NOT feature any Cross-Origin Resource Sharing (CORS) / CORS-Headers as it is meant for server-side consumption only.
We are offering authentication via OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.
For more infos see our OAuth documentation.
User Credential Grant
Header: X-Justimmo-TenantId: <id>
This is necessary to determine which tenant's data to operate on.
authorizationCode
https://auth.justimmo.at/authorize
https://auth.justimmo.at/access_token
Client Credential Grant with User Impersonation
Header: X-Justimmo-TenantId: <id>
This is necessary to determine which tenant's data to operate on.
Header: X-Justimmo-UserId: <id>
This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions.
clientCredentials
https://auth.justimmo.at/access_token
Not every client has access to all the properties / functionality listed in this document, based on predefined client scopes. If any properties or functionality you need are missing, please contact us and we will reevaluate the scopes granted to you.
To protect our servers, there is a rate limit in place: You may make up to 10 requests per second and IP address on average. Past that the server may refuse your request and answer with http status code 429 - Too Many Requests
.
Create an activity for a realty or contact.
Despite being nullable, either realty_id
or contact_id
(or both) need to be present in the request body.
If called via auth_token
, the activity will show as created by the token's owner.
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
activity_type_id required | integer The numerical representation of the type of activity (ie "Contact has been updated", "Realty has changed status", etc...). |
realty_id | integer or null |
contact_id | integer or null |
text | string or null |
created_at | string or null <date-time> RFC-3339 If no |
{- "activity_type_id": 1020,
- "realty_id": 0,
- "contact_id": 0,
- "text": "string",
- "created_at": "2020-05-01T12:13:25+00:00"
}
{- "id": 939482
}
Retrieve activity information
activityId required | integer <int64> >= 1 The id of the activity |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "id": 575693,
- "tenant_id": 5,
- "created_at": "2020-05-01T12:13:25+00:00",
- "sort_date": "2020-05-01T12:13:25+00:00",
- "from": "2020-05-01T12:13:25+00:00",
- "to": "2020-05-01T12:13:25+00:00",
- "activity_type": {
- "id": 5756,
- "name": "Objekt erstellt"
}, - "agent": {
- "id": 5756
}, - "contact": {
- "id": 5756
}, - "realty": {
- "id": 5756
}, - "offer": {
- "id": 5756
}, - "comment": "Balkon zu klein",
- "offertext": "Sehr geehrter Herr Mustermann, [...]",
- "files": [
- {
- "type": "document",
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "original_filename": "Nebenkostenübersicht.pdf",
- "title": "Nebenkostenübersicht",
- "description": "Nebenkostenübersicht zum Objekt",
- "sort_order": 13,
- "visibility": "public",
- "active": true,
- "group": {
- "id": 0
}, - "original_filesize": 0,
- "mime_type": "application/pdf",
- "uploaded_at": "1985-04-12 14:12:12"
}
]
}
Uploads a file and attaches it to the activity
activityId required | integer <int64> >= 1 The id of the activity |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
file required | string <binary> |
title | string |
[- {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg"
}
]
Deletes a file attached to an activity
activityId required | integer <int64> >= 1 The id of the activity |
storageKey required | string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+ The storageKey of the file |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Retrieve activities for a realty
If different filter parameters are provided, those are related by AND
.
If more than one value is provided for any given filter, they are treated with an OR
relation.
realtyId required | integer <int64> >= 1 The id of the realty |
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
locale | string = 2 characters Example: locale=de |
offset | integer >= 0 Default: 0 Skip the first |
object Filters the results |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "id": 575693,
- "tenant_id": 5,
- "created_at": "2020-05-01T12:13:25+00:00",
- "sort_date": "2020-05-01T12:13:25+00:00",
- "from": "2020-05-01T12:13:25+00:00",
- "to": "2020-05-01T12:13:25+00:00",
- "activity_type": {
- "id": 5756,
- "name": "Objekt erstellt"
}, - "agent": {
- "id": 5756
}, - "contact": {
- "id": 5756
}, - "realty": {
- "id": 5756
}, - "offer": {
- "id": 5756
}, - "comment": "Balkon zu klein",
- "offertext": "Sehr geehrter Herr Mustermann, [...]",
- "files": [
- {
- "type": "document",
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "original_filename": "Nebenkostenübersicht.pdf",
- "title": "Nebenkostenübersicht",
- "description": "Nebenkostenübersicht zum Objekt",
- "sort_order": 13,
- "visibility": "public",
- "active": true,
- "group": {
- "id": 0
}, - "original_filesize": 0,
- "mime_type": "application/pdf",
- "uploaded_at": "1985-04-12 14:12:12"
}
]
}
]
}
Retrieve a list of appointments
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
offset | integer >= 0 Default: 0 Skip the first |
object Example: filters[contact_id]=123,124 |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This allows your client to act on behalf of a specific user, adhering to the user's permissions. required only for authorization method |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "id": 5629,
- "type": "meeting",
- "from": "2024-11-06T13:30:00+00:00",
- "to": "2024-11-06T13:37:00+00:00",
- "state": {
- "state": "done",
- "changed_at": "2024-11-06T13:37:00+00:00"
}, - "agent": {
- "id": 5674
}, - "contact": {
- "id": 4356
}, - "realty": {
- "id": 3245
}, - "invite": {
- "attach_address": "custom",
- "address": "Wayne Manor, 224 Park Drive, Gotham City"
}, - "comment": "string",
- "exclude_from_report": false
}
]
}
Create a new appointment
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
type required | string Value: "meeting" |
from | string <date-time> RFC-3339 |
to | string or null <date-time> RFC-3339 |
agent_id | integer or null <int64> The agent this appointment should be assigned to. If not provided or |
contact_id | integer or null <int64> required if |
realty_id | integer or null <int64> required if |
object or null (WriteAppointmentInvite) The contact as specified by If this property is | |
comment | string or null |
exclude_from_report | boolean Default: false |
{- "type": "meeting",
- "from": "2024-11-06T13:30:00+00:00",
- "to": "2024-11-06T13:37:00+00:00",
- "agent_id": 979443,
- "contact_id": 579696,
- "realty_id": 4869,
- "invite": {
- "attach_address": "custom",
- "custom_address": "Wayne Manor, 224 Park Drive, Gotham City"
}, - "comment": "string",
- "exclude_from_report": false
}
{- "id": 57593657
}
Update an existing appointment
appointmentId required | integer <int64> >= 1 The id of the appointment |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
from | string <date-time> RFC-3339 |
to | string or null <date-time> RFC-3339 |
agent_id | integer <int64> The agent this appointment should be assigned to. |
contact_id | integer <int64> Changing the contact is not allowed if it has previously been set already |
realty_id | integer <int64> |
object or null (WriteAppointmentInvite) The contact as specified by If this property is | |
comment | string or null |
exclude_from_report | boolean Default: false |
{- "from": "2024-11-06T13:30:00+00:00",
- "to": "2024-11-06T13:37:00+00:00",
- "agent_id": 979443,
- "contact_id": 579696,
- "realty_id": 4869,
- "invite": {
- "attach_address": "custom",
- "custom_address": "Wayne Manor, 224 Park Drive, Gotham City"
}, - "comment": "string",
- "exclude_from_report": false
}
{ }
Deletes an appointment
appointmentId required | integer <int64> >= 1 The id of the appointment |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Create an new acquisition realty
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
required | object (CreateRealtyAddress) |
land_registry_number | string Deprecated Einlagezahl (EZ) Country must be Austria. Deprecated: Use Create/Update RealtyLandRegisterEntry endpoints instead or use POST Creates a new LandRegisterEntry with the values provided in land_registry_number, cadastral_municipality and plot_numbers. If neither of those values are provided, the values are determined automatically based on the realty address. PATCH Updates the land_register_entry_number of the first LandRegisterEntry or creates a new LandRegisterEntry if no entry exists yet. |
cadastral_municipality | string Deprecated Katastralgemeinde Nummer (KG-NR) Country must be Austria. Deprecated: Use Create/Update RealtyLandRegisterEntry endpoints instead or use POST Creates a new LandRegisterEntry with the values provided in land_registry_number, cadastral_municipality and plot_numbers. If neither of those values are provided, the values are determined automatically based on the realty address. PATCH Updates the cadastral_municipality_id of the first LandRegisterEntry or creates a new LandRegisterEntry if no entry exists yet. |
plot_number | string Deprecated Grundstücksnummern (GST-NR) Country must be Austria. Deprecated: Use Create/Update RealtyLandRegisterEntry endpoints instead or use POST Creates a new LandRegisterEntry with the values provided in land_registry_number, cadastral_municipality and plot_numbers. If neither of those values are provided, the values are determined automatically based on the realty address. PATCH Overwrites all plot_numbers of the first LandRegisterEntry or creates a new LandRegisterEntry if no entry exists yet. The provided value is stored as a single plot number. |
type_id required | integer Objektart Id |
subtype_id | integer Subobjektart Id |
required | object Nutzungsart At least one of these must be |
marketing_type required | string (RealtyMarketingType) Enum: "buy" "rent" Vermarktungsart |
architecture | string or null (RealtyArchitecture) Enum: "new" "old" Bauart (Neubau / Altbau) |
year_of_construction | integer or null |
infrastructure_provision | string or null (RealtyInfrastructureProvision) Enum: "not_developed" "partially_developed" "fully_developed" Erschließung (Unerschlossen / Teilerschlossen / Vollerschlossen) |
year_of_last_renovation | integer or null |
year_of_last_comprehensive_renovation | integer or null |
object | |
object (RealtyFloors) | |
object or null (WriteRooms) | |
room_layout | string or null (RoomLayout) Enum: "centrally_accessible" "partly_centrally_accessible" "circularly_accessible" "loft" "centrally_accessible": zentral begehbar |
currency | string = 3 characters Enum: "EUR" "USD" "CHF" "HUF" "PLN" "RON" "AED" ISO 4217 Code Currently, only "EUR" is supported. |
object The currency for these prices is determined by the realty's | |
earnings_per_year_net | number <float> Nettoertrag pro Jahr The currency is determined by the realty's |
object POST Either | |
category_ids | Array of integers <int64> [ items <int64 > ] |
agent_id required | integer <int64> |
object (RealtyTexts) | |
object or null (InputEnergyPerformanceCertification) Energieausweis If a | |
feature_ids | Array of integers <int32> [ items <int32 > ] Ausstattungsmerkmale |
accessible | boolean Default: false barrierefrei |
object (WriteRealtyRentDetails) | |
object (WriteCommission) | |
condition_assessment | string or null (RealtyConditionAssessment) Enum: "very_good" "good" "medium" "bad" Zustandsbewertung |
realty_condition_id | integer or null |
building_condition_id | integer or null |
object (AcquisitionRealtyAgencyAgreement) | |
Array of objects (CustomField) | |
automatic_hits | boolean |
object Country must be Austria. If no data is provided, the land register entry is determined automatically based on the realty address. If this property is provided, the deprecated properties | |
created_at | string <date-time> (WriteCreatedAt) RFC-3339 If no |
ownership_type_id | integer or null (WriteOwnershipTypeId) Eigentumsform |
furnishing_id | integer or null (WriteFurnishingId) Möblierung |
noise_level_id | integer or null (WriteNoiseLevelId) Lärmpegel |
location_assessment | string or null (WriteLocationAssessment) Enum: "very good" "good" "medium" "bad" Lagebewertung |
{- "address": {
- "street": "Mariahilferstraße",
- "number": "127",
- "entrance": "5",
- "door": "3a",
- "zip": "1070",
- "city": "Wien",
- "country": "AT",
- "floor_idx": 2,
- "floor_description": "3. Stock"
}, - "land_registry_number": "600",
- "cadastral_municipality": "01010",
- "plot_number": "1234/1, 1234/2",
- "type_id": 8,
- "subtype_id": 80,
- "occupancy": {
- "residential": true,
- "commercial": true,
- "investment": true
}, - "marketing_type": "buy",
- "architecture": "new",
- "year_of_construction": 0,
- "infrastructure_provision": "not_developed",
- "year_of_last_renovation": 0,
- "year_of_last_comprehensive_renovation": 0,
- "areas": {
- "site_area": {
- "area": 50.5
}, - "living_area": {
- "area": 50.5
}, - "floor_area": {
- "area": 50.5
}, - "developable_area": {
- "area": 50.5
}, - "office_area": {
- "area": 50.5
}, - "sales_area": {
- "area": 50.5
}, - "storage_area": {
- "area": 50.5
}, - "available_area": {
- "area": 50.5
}, - "short_term_area": {
- "area": 50.5
}, - "total_area": {
- "area": 50.5
}, - "weighted_area": {
- "area": 50.5
}, - "undeveloped_attic": true,
- "undeveloped_attic_area": {
- "area": 50.5
}, - "garden_area": {
- "area": 50.5,
- "count": 2
}, - "basement_area": {
- "area": 50.5,
- "count": 2
}, - "balcony_area": {
- "area": 50.5,
- "count": 2
}, - "terrace_area": {
- "area": 50.5,
- "count": 2
}, - "covered_balcony_area": {
- "area": 50.5,
- "count": 2
}, - "garage_area": {
- "area": 50.5,
- "count": 2
}, - "parking_space_area": {
- "area": 50.5,
- "count": 2
}
}, - "floors": {
- "count_floors": 0,
- "count_attic_floors": 0,
- "mezzanine": false
}, - "rooms": {
- "rooms": 4,
- "rooms_add_half": false,
- "toilets": 3,
- "bathrooms": 2,
- "storerooms": 1
}, - "room_layout": "centrally_accessible",
- "currency": "EUR",
- "prices": {
- "purchase_price": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "rent": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "furniture_hire": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "parking": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "garage": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "operating": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "heating": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "hot_water": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "cooling": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "maintenance_funds": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "elevator": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "others": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}
}, - "earnings_per_year_net": 1234.56,
- "obtainable_from": {
- "date": "2021-06-05",
- "text": "string"
}, - "category_ids": [
- 123
], - "agent_id": 5756,
- "texts": {
- "label": "W-1728",
- "title": [
- {
- "value": "3-Zimmer-Wohnung mit Balkon Nähe Unterhupfing",
- "locale": "de"
}
], - "location": [
- {
- "value": "Am Rande des der Kleinstadt Unterhupfing, unweit eines schönen Badesees in einer ruhigen Nebenstraße",
- "locale": "de"
}
], - "description": [
- {
- "value": "Die Wohnung befindet sich in einer kleinen sehr ruhigen Wohnanlage in unmittelbarer Nähe zum Badesee.\n\nDer geräumige Südbalkon ist überdacht und bietet einen schönen Ausblick.",
- "locale": "de"
}
], - "description_expose": [
- {
- "value": "Die Wohnung befindet sich in einer kleinen sehr ruhigen Wohnanlage in unmittelbarer Nähe zum Badesee.\n\nDer geräumige Südbalkon ist überdacht und bietet einen schönen Ausblick.",
- "locale": "de"
}
]
}, - "energy_performance_certification": {
- "energy_performance": {
- "value": 1.67,
- "class": "C"
}, - "heating_demand": {
- "value": 95.65,
- "class": "C"
}, - "valid_until": "2022-07-18",
- "auto_disclaimer": true
}, - "feature_ids": [
- 1,
- 2,
- 1234,
- 11,
- 12,
- 5678
], - "accessible": false,
- "rent_details": {
- "costs": {
- "buyout": 0,
- "security_deposit": {
- "value": 3,
- "type": "monthly_rent_gross_text",
- "auto_text": true,
- "text": "3 Bruttomonatsmieten"
}, - "financing_contribution": 0,
- "explanation": "string",
- "stamp_duty": {
- "auto_value": true,
- "value": null,
- "text": "string"
}
}, - "purchase_option": false
}, - "commission": {
- "prospect": {
- "principle_of_first_instruction": true,
- "type": "percentage_value",
- "value": 3,
- "vat": 20,
- "auto_text": false,
- "text_value": "3% des Kaufpreises zzgl. 20% USt."
}, - "vendor": {
- "type": "percentage",
- "value": 3,
- "vat": 20
}
}, - "condition_assessment": "very_good",
- "realty_condition_id": 0,
- "building_condition_id": 0,
- "agency_agreement": {
- "business_opportunity_knowledge_date": "2021-06-05"
}, - "custom_fields": [
- {
- "type": "boolean",
- "name": "active",
- "value": true
}
], - "automatic_hits": true,
- "land_register_entry": {
- "land_register_entry_number": "600",
- "cadastral_municipality_id": "01010",
- "plot_numbers": [
- "274"
], - "owner_sequence_numbers": [
- 3
]
}, - "created_at": "2020-05-01T12:13:25+00:00",
- "ownership_type_id": 2,
- "furnishing_id": 2,
- "noise_level_id": 2,
- "location_assessment": "very good"
}
{- "id": 939482,
- "catalogue_number": {
- "plain": 123,
- "display": "5/123"
}
}
Uploads a file and attaches it to the realty
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
file required | string <binary> |
title | string |
description | string |
group_id required | string\d+ The group of the file |
sort_order | string\d+ If provided, reorders the attachments of the same realty and group to fit this new file in a specific position. This can be a positive or negative value:
|
[- {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg"
}
]
Deletes a file attached to a realty
realtyId required | integer <int64> >= 1 The id of the realty |
storageKey required | string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+ The storageKey of the file |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Attaches a new land register entry to the realty
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
land_register_entry_number | string non-empty Einlagezahl (EZ) Country must be Austria. |
cadastral_municipality_id required | string non-empty Katastralgemeinde Nummer (KG-NR) Country must be Austria. |
plot_numbers | Array of strings non-empty [ items non-empty ] Grundstücksnummern (GST-NRn) Country must be Austria. |
owner_sequence_numbers | Array of integers Laufende Nummern im Eigentumsblatt (B-Blatt) Country must be Austria. |
{- "land_register_entry_number": "600",
- "cadastral_municipality_id": "01010",
- "plot_numbers": [
- "274"
], - "owner_sequence_numbers": [
- 3
]
}
{- "id": 939482
}
Deletes a land register entry attached to a realty
realtyId required | integer <int64> >= 1 The id of the realty |
realtyLandRegisterEntryId required | integer <int64> >= 1 The id of the land register entry |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Attaches a new link to the realty
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
url required | string <url> non-empty |
description required | string |
type required | string Enum: "link" "video" "tour" "project" |
object |
{- "description": "Online 3D Rundgang",
- "type": "tour",
- "export": {
- "offer": true,
- "platform": true,
- "website": true,
- "other": true
}
}
{- "id": 939482
}
Deletes a link attached to a realty
realtyId required | integer <int64> >= 1 The id of the realty |
realtyLinkId required | integer <int64> >= 1 The id of the realty link |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Attaches a contact to a realty as a vendor
realtyId required | integer <int64> >= 1 The id of the realty |
vendorId required | integer <int64> >= 1 The id of the vendor |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Detaches a vendor from a realty
realtyId required | integer <int64> >= 1 The id of the realty |
vendorId required | integer <int64> >= 1 The id of the vendor |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Retrieve contact list
If different filter parameters are provided, those are related by AND
.
If more than one value is provided for any given filter, they are treated with an OR
relation.
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
offset | integer >= 0 Default: 0 Skip the first |
object Filters the results |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "id": 5756,
- "catalogue_number": 5756,
- "tenant_id": 5,
- "created_at": "2020-05-01T12:13:25+00:00",
- "updated_at": "2020-05-01T12:13:25+00:00",
- "email": "support@justimmo.at",
- "email_addresses": [
- {
- "id": 123,
- "address": "support@justimmo.at",
- "used_for_communication": true
}
], - "phone_mobile": "0123 4567890",
- "phone_private": "0123 4567890",
- "phone_business": "0123 4567890",
- "address": {
- "street": "Mariahilferstraße 8/11",
- "zip": "1070",
- "city": "Wien",
- "country": "AT"
}, - "mailing_address": "Mariahilferstraße 8/11\nA-1070 Wien",
- "mailing_salutation": "Sehr geehrter Herr Immo",
- "economic_relationship": "family",
- "categories": [
- {
- "id": 123,
- "name": "Interessent",
- "is_marketing_category": true,
- "is_newsletter_category": true
}
], - "agent": {
- "id": 5756,
- "prefix": "Dr.",
- "first_name": "Justine",
- "last_name": "Immo",
- "gender": "female",
- "date_of_birth": "1971-03-27",
- "suffix": "MBA",
- "email": "support@justimmo.at",
- "phone": "0123 4567890",
- "phone_mobile": "0123 4567890",
- "phone_business": "0123 4567890",
- "phone_fax": "0123 4567890",
- "profile_picture": {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg",
- "filename": "file.jpg",
- "title": "Example File Description"
}, - "position": "string",
- "immobiliencard_id": "AT01234567",
- "immobiliencard_uid": "string",
- "foreign_id": 1234,
- "role": "employee",
- "permissions": {
- "realty_module_enabled": true,
- "realty_create": true,
- "realty_view": "own",
- "realty_view_vendors": "own",
- "realty_view_internal_files": "own",
- "realty_edit": "own",
- "realty_delete": "own",
- "realty_export": "own",
- "contact_module_enabled": true,
- "contact_create": true,
- "contact_view": "own",
- "contact_edit": "own",
- "contact_delete": "own"
}, - "tenant": {
- "id": 123,
- "name": "Justimmo",
- "email": "support@justimmo.at",
- "phone": "+43 1 2345678",
- "address": {
- "street": "Mariahilferstraße 8/11",
- "zip": "1070",
- "city": "Wien",
- "country": "AT"
}
}
}, - "active": true,
- "type": "company"
}
]
}
Create an new contact
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
type required | string |
string or null <email> | |
phone_mobile | string or null |
phone_private | string or null |
phone_business | string or null |
object | |
economic_relationship | string or null (ContactEconomicRelationship) Deprecated Enum: "family" "family_double_agent" "economic" "economic_double_agent" Naheverhältnis see Lookup Tables: ContactEconomicRelationship
Due to the recent change in the Austrian brokerage law act (Erstauftraggeberprinzip), this property is being phased out and replaced with `vendor_economic_relationship`.
Information about dual_brokerage (Doppelmaklertätigkeit) is now separately available for read and write in the Realty context.
|
vendor_economic_relationship | string or null (VendorEconomicRelationship) Enum: "none" "family_or_economic" "economic_interconnection" Naheverhältnis |
category_ids | Array of integers <int64> [ items <int64 > ] |
agent_id required | integer <int64> |
prefix | string or null |
gender | string or null Enum: "male" "female" |
first_name | string or null |
last_name | string or null |
suffix | string or null |
birthday | string or null <date> RFC-3339 |
company required | string or null |
position | string or null |
commercial_register_nr | string or null Firmenbuchnummer |
vat_number | string or null UID |
created_at | string <date-time> (WriteCreatedAt) RFC-3339 If no |
locale | string = 2 characters Default: "de" |
source_id | integer <int32> (CreateContactSourceId) The numerical representation of the source the contact was acquired from
(ie Social Media, Printanzeige,
Empfehlung, Laufkunde, etc...).
Please contact us to inquire what |
{- "type": "company",
- "email": "support@justimmo.at",
- "phone_mobile": "0123 4567890",
- "phone_private": "0123 4567890",
- "phone_business": "0123 4567890",
- "address": {
- "street": "Mariahilferstraße 8/11",
- "zip": "1070",
- "city": "Wien",
- "country": "AT"
}, - "economic_relationship": "family",
- "vendor_economic_relationship": "none",
- "category_ids": [
- 123
], - "agent_id": 5756,
- "prefix": "Dr.",
- "gender": "female",
- "first_name": "Justin",
- "last_name": "Immo",
- "suffix": "MBA",
- "birthday": "1985-04-12",
- "company": "Example GmbH",
- "position": "CEO",
- "commercial_register_nr": "FN 123456a",
- "vat_number": "ATU 12345678",
- "created_at": "2020-05-01T12:13:25+00:00",
- "locale": "de",
- "source_id": 5756
}
{- "id": 939482,
- "catalogue_number": 15
}
Update an existing contact
contactId required | integer <int64> >= 1 The id of the contact |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
type required | string |
string or null <email> Deprecated If the email already exists for this contact, it will be ignored. To just add an email address, we recommend using the Add Email Address Call instead. | |
phone_mobile | string or null |
phone_private | string or null |
phone_business | string or null |
object | |
economic_relationship | string or null (ContactEconomicRelationship) Deprecated Enum: "family" "family_double_agent" "economic" "economic_double_agent" Naheverhältnis see Lookup Tables: ContactEconomicRelationship
Due to the recent change in the Austrian brokerage law act (Erstauftraggeberprinzip), this property is being phased out and replaced with `vendor_economic_relationship`.
Information about dual_brokerage (Doppelmaklertätigkeit) is now separately available for read and write in the Realty context.
|
vendor_economic_relationship | string or null (VendorEconomicRelationship) Enum: "none" "family_or_economic" "economic_interconnection" Naheverhältnis |
category_ids | Array of integers <int64> [ items <int64 > ] |
agent_id | integer <int64> |
prefix | string or null |
gender | string or null Enum: "male" "female" |
first_name | string or null |
last_name | string or null |
suffix | string or null |
birthday | string or null <date> RFC-3339 |
company | string or null |
position | string or null |
commercial_register_nr | string or null Firmenbuchnummer |
vat_number | string or null UID |
locale | string = 2 characters |
source_id | integer or null <int32> (UpdateContactSourceId) The numerical representation of the source the contact was acquired from
(ie Social Media, Printanzeige,
Empfehlung, Laufkunde, etc...).
Please contact us to inquire what |
{- "type": "company",
- "email": "support@justimmo.at",
- "phone_mobile": "0123 4567890",
- "phone_private": "0123 4567890",
- "phone_business": "0123 4567890",
- "address": {
- "street": "Mariahilferstraße 8/11",
- "zip": "1070",
- "city": "Wien",
- "country": "AT"
}, - "economic_relationship": "family",
- "vendor_economic_relationship": "none",
- "category_ids": [
- 123
], - "agent_id": 5756,
- "prefix": "Dr.",
- "gender": "female",
- "first_name": "Justin",
- "last_name": "Immo",
- "suffix": "MBA",
- "birthday": "1985-04-12",
- "company": "Example GmbH",
- "position": "CEO",
- "commercial_register_nr": "FN 123456a",
- "vat_number": "ATU 12345678",
- "locale": "de",
- "source_id": 5756
}
{ }
Retrieve contact information
contactId required | integer <int64> >= 1 The id of the contact |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "id": 5756,
- "catalogue_number": 5756,
- "tenant_id": 5,
- "created_at": "2020-05-01T12:13:25+00:00",
- "updated_at": "2020-05-01T12:13:25+00:00",
- "email": "support@justimmo.at",
- "email_addresses": [
- {
- "id": 123,
- "address": "support@justimmo.at",
- "used_for_communication": true
}
], - "phone_mobile": "0123 4567890",
- "phone_private": "0123 4567890",
- "phone_business": "0123 4567890",
- "address": {
- "street": "Mariahilferstraße 8/11",
- "zip": "1070",
- "city": "Wien",
- "country": "AT"
}, - "mailing_address": "Mariahilferstraße 8/11\nA-1070 Wien",
- "mailing_salutation": "Sehr geehrter Herr Immo",
- "economic_relationship": "family",
- "vendor_economic_relationship": "none",
- "categories": [
- {
- "id": 123,
- "name": "Interessent",
- "is_marketing_category": true,
- "is_newsletter_category": true
}
], - "realties": [
- {
- "role": "vendor",
- "realty": {
- "id": 5756,
- "created_at": "2020-05-01T12:13:25+00:00",
- "updated_at": "2020-05-01T12:13:25+00:00"
}
}
], - "agent": {
- "id": 5756,
- "prefix": "Dr.",
- "first_name": "Justine",
- "last_name": "Immo",
- "gender": "female",
- "date_of_birth": "1971-03-27",
- "suffix": "MBA",
- "email": "support@justimmo.at",
- "phone": "0123 4567890",
- "phone_mobile": "0123 4567890",
- "phone_business": "0123 4567890",
- "phone_fax": "0123 4567890",
- "profile_picture": {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg",
- "filename": "file.jpg",
- "title": "Example File Description"
}, - "position": "string",
- "immobiliencard_id": "AT01234567",
- "immobiliencard_uid": "string",
- "foreign_id": 1234,
- "role": "employee",
- "permissions": {
- "realty_module_enabled": true,
- "realty_create": true,
- "realty_view": "own",
- "realty_view_vendors": "own",
- "realty_view_internal_files": "own",
- "realty_edit": "own",
- "realty_delete": "own",
- "realty_export": "own",
- "contact_module_enabled": true,
- "contact_create": true,
- "contact_view": "own",
- "contact_edit": "own",
- "contact_delete": "own"
}, - "tenant": {
- "id": 123,
- "name": "Justimmo",
- "email": "support@justimmo.at",
- "phone": "+43 1 2345678",
- "address": {
- "street": "Mariahilferstraße 8/11",
- "zip": "1070",
- "city": "Wien",
- "country": "AT"
}
}
}, - "active": true,
- "type": "company",
- "salutation": "string",
- "prefix": "Dr.",
- "gender": "female",
- "first_name": "Justin",
- "last_name": "Immo",
- "suffix": "MBA",
- "birthday": "1985-04-12",
- "company": "Example GmbH",
- "position": "CEO",
- "commercial_register_nr": "FN 123456a",
- "vat_number": "ATU 12345678"
}
Activate an existing contact
contactId required | integer <int64> >= 1 The id of the contact |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Deactivate an existing contact
contactId required | integer <int64> >= 1 The id of the contact |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Unsubscribe from any newsletters the contact may be subscribed to by removing their newsletter categories.
contactId required | integer <int64> >= 1 The id of the contact |
categoryId | integer >= 1 ID of the newsletter category to unsubscribe from. If not provided, all newsletters will be unsubscribed |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Adds an email address to a contact's list of email addresses
contactId required | integer <int64> >= 1 The id of the contact |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
address required | string <email> |
used_for_communication required | boolean |
{- "address": "support@justimmo.at",
- "used_for_communication": true
}
{- "id": 46232
}
Deletes an email address from a contact's list of email addresses
contactId required | integer <int64> >= 1 The id of the contact |
emailAddressId required | integer >= 1 The id of the email address |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Retrieve list of search profiles for a contact
contactId required | integer <int64> >= 1 The id of the contact |
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
locale | string = 2 characters Example: locale=de |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
[- {
- "id": 5756,
- "contact": {
- "id": 5756
}, - "agent": {
- "id": 6789
}, - "creator": {
- "id": 5756
}, - "created_at": "2023-05-01T12:13:25+00:00",
- "updated_at": "2023-05-01T12:13:25+00:00",
- "expires_at": "2024-05-01",
- "search_contract": true,
- "search_contract_accepted_at": "2023-07-12T12:28:23+00:00",
- "state": "active",
- "auto_description": "Kauf, Wohnfl.: 73 m² bis 137 m², Bezirk: Wien 3., Landstraße, Wohnung",
- "notes": "string",
- "criteria": {
- "types": [
- {
- "id": 8,
- "name": "Industrie / Gewerbe",
- "openimmo_key": "hallen_lager_prod"
}
], - "subtypes": [
- {
- "id": 80,
- "name": "Hochregallager",
- "openimmo_key": "HOCHREGALLAGER"
}
], - "occupancy": "residential",
- "marketing_type": "buy",
- "rent_duration": {
- "from": 0,
- "unlimited": true
}, - "price": {
- "from": 3,
- "to": 4
}, - "price_per_area": {
- "from": 1234.56,
- "to": 1234.56
}, - "rooms": {
- "from": 3,
- "to": 4
}, - "yield": {
- "from": 0.1
}, - "site_area": {
- "from": 50,
- "to": 150
}, - "living_area": {
- "from": 50,
- "to": 150
}, - "floor_area": {
- "from": 50,
- "to": 150
}, - "office_area": {
- "from": 50,
- "to": 150
}, - "sales_area": {
- "from": 50,
- "to": 150
}, - "storage_area": {
- "from": 50,
- "to": 150
}, - "commission_free": true,
- "location": {
- "location_ids": [
- {
- "type": "federal_state",
- "id": 123,
- "text": "Wien"
}
]
}, - "architecture": "new",
- "year_of_construction": {
- "from": 3,
- "to": 4
}, - "conditions": [
- {
- "id": 1234,
- "name": "baufällig"
}
], - "floor": "ground",
- "energy_performance_class": "C",
- "category_ids": [
- 123
], - "furnishings": [
- {
- "id": 1234,
- "name": "Kochnische"
}
], - "covered_balcony": {
- "enabled": true,
- "from": 17
}, - "balcony": {
- "enabled": true,
- "from": 17
}, - "terrace": {
- "enabled": true,
- "from": 17
}, - "garden": {
- "enabled": true,
- "from": 17
}, - "accessible": true,
- "features": [
- {
- "group_label": "Boden",
- "items": [
- {
- "id": 1,
- "label": "Dielen"
}, - {
- "id": 2,
- "label": "Doppelboden"
}, - {
- "id": 1234,
- "label": "Spezialstahl",
- "tenant_id": 123
}
]
}, - {
- "group_label": "Befeuerung",
- "items": [
- {
- "id": 11,
- "label": "Elektro"
}, - {
- "id": 12,
- "label": "Erdwärme"
}, - {
- "id": 5678,
- "label": "Nuklear",
- "tenant_id": 123
}
]
}
]
}, - "automatic_hits": true
}
]
Retrieve hitlist for a contact
Hits are generated based on the users search profiles, but are not specific to them.
contactId required | integer <int64> >= 1 The id of the contact |
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
locale | string = 2 characters Example: locale=de |
offset | integer >= 0 Default: 0 Skip the first |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "realty": {
- "id": 1234
}, - "search_profiles": [
- {
- "data": {
- "id": 23,
- "auto_description": "Kauf, Wohnfl.: 73 m² bis 137 m², Bezirk: Wien 3., Landstraße, Wohnung"
}
}
], - "created_at": "1985-04-12 14:12:12"
}
]
}
Accept CommissionContract
Use AcceptCommissionContractOfferBody
as Request Body to accept the contract for an entire offer,
or AcceptCommissionContractRealtyBody
to accept the contract for a single realty that hasn't been offered to the contact,
or AcceptSearchContractBody
(Work in Progress) to accept the contract for a search profile.
AcceptSearchContractBody
is Work in Progress for internal testing, do not use yet.
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
offer_id required | integer <int64> |
contact_id required | integer <int64> |
accepted_by_ip required | string IPv4 (123.123.123.123) or IPv6 (fe80::1ff:fe23:4567:890a) |
{- "offer_id": 6578612,
- "contact_id": 23478439,
- "accepted_by_ip": "123.123.123.123"
}
{- "id": 576784,
- "file": {
- "type": "document",
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "original_filename": "Nebenkostenübersicht.pdf",
- "title": "Nebenkostenübersicht",
- "description": "Nebenkostenübersicht zum Objekt",
- "sort_order": 13,
- "visibility": "public",
- "active": true,
- "group": {
- "id": 0
}, - "original_filesize": 0,
- "mime_type": "application/pdf",
- "uploaded_at": "1985-04-12 14:12:12"
}
}
Preview CommissionContract
Use PreviewCommissionContractOfferBody
as Request Body to preview the contract for an entire offer,
or PreviewCommissionContractRealtyBody
to preview the contract for a single realty that hasn't been offered to the contact,
or PreviewSearchContractBody
(Work in Progress) to preview the contract for a search profile.
PreviewSearchContractBody
is Work in Progress for internal testing, do not use yet.
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
offer_id required | integer <int64> |
contact_id required | integer <int64> |
{- "offer_id": 6578612,
- "contact_id": 23478439
}
{- "salutation": "string",
- "teaser": "string",
- "text": "string"
}
Retrieve file content
storageKey required | string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+ The storageKey of the file |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This allows your client to act on behalf of a specific user, adhering to the user's permissions. required only for authorization method |
{- "title": "An error occurred",
- "status": "4xx",
- "detail": "Example Error"
}
Retrieve file content of a thumbnail
config required | string The thumbnail config of the file |
storageKey required | string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+ The storageKey of the file |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This allows your client to act on behalf of a specific user, adhering to the user's permissions. required only for authorization method |
{- "title": "An error occurred",
- "status": "4xx",
- "detail": "Example Error"
}
Uploads a file and attaches it to the realty
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
file required | string <binary> |
title | string |
description | string |
group_id required | string\d+ The group of the file |
sort_order | string\d+ If provided, reorders the attachments of the same realty and group to fit this new file in a specific position. This can be a positive or negative value:
|
[- {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg"
}
]
Deletes a file attached to a realty
realtyId required | integer <int64> >= 1 The id of the realty |
storageKey required | string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+ The storageKey of the file |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Update an existing realty file's metadata
realtyId required | integer <int64> >= 1 The id of the realty |
storageKey required | string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+ The storageKey of the file |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
title | string As the title is part of the file itself, not the attachment, changing it is only allowed on files that are attached to this realty only. |
description | string As the description is part of the file itself, not the attachment, changing it is only allowed on files that are attached to this realty only. |
sort_order | integer If provided, reorders the attachments of the same realty and group to fit this new file in a specific position. This can be a positive or negative value:
|
{- "title": "string",
- "description": "string",
- "sort_order": 0
}
{ }
Retrieve inquiry list
If different filter parameters are provided, those are related by AND
.
If more than one value is provided for any given filter, they are treated with an OR
relation.
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
offset | integer >= 0 Default: 0 Skip the first |
object Example: filters[contact_id]=123,124 |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "id": 7598,
- "created_at": "2020-05-01T12:13:25+00:00",
- "message": "string",
- "agent": {
- "id": 5756
}, - "contact": {
- "id": 5756,
- "cache": {
- "company_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address": "string"
}
}, - "realty": {
- "id": 576944,
- "cache": {
- "title": "string",
- "address": "string",
- "url": "string"
}
}, - "source": {
- "id": 8,
- "name": "Immobilienplattform",
- "feed": {
- "id": 58304,
- "name": "willhaben.at",
- "category": "platform"
}, - "platform": {
- "id": 6,
- "name": "willhaben.at"
}
}
}
]
}
Create an inquiry for a contact and optionally a realty.
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
contact_id required | integer <int64> |
realty_id | integer or null <int64> |
message | string or null |
source_id | integer or null The id of the source where the contact heard about the realty offer. |
agent_id | integer <int64> The agent to whom the inquiry will be assigned to. If omitted, the inquiry will be assigned to the owner of the realty, if available. Otherwise the inquiry is assigned to the first administrator user of the tenant. |
funding_inquiry_request | boolean If this option is set to Additional paid service that can be activated in Justimmo. |
{- "contact_id": 23478439,
- "realty_id": 11104565,
- "message": "Ich habe Interesse an dieser Wohnung.",
- "source_id": 0,
- "agent_id": 5756,
- "funding_inquiry_request": false
}
{- "id": 24349621,
- "contact": {
- "id": 3467823
}
}
Retrieve inquiry information
inquiryId required | integer >= 1 The id of the inquiry |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "id": 7598,
- "created_at": "2020-05-01T12:13:25+00:00",
- "message": "string",
- "agent": {
- "id": 5756
}, - "contact": {
- "id": 5756,
- "cache": {
- "company_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address": "string"
}
}, - "realty": {
- "id": 576944,
- "cache": {
- "title": "string",
- "address": "string",
- "url": "string"
}
}, - "source": {
- "id": 8,
- "name": "Immobilienplattform",
- "feed": {
- "id": 58304,
- "name": "willhaben.at",
- "category": "platform"
}, - "platform": {
- "id": 6,
- "name": "willhaben.at"
}
}
}
List cities belonging to a certain zip code.
zip required | integer [ 1000 .. 9999 ] Example: 1010 The zip code to find matching cities for. |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
[- "Wien, Innere Stadt"
]
Search for locations of all types matching the given query string.
query required | string >= 2 characters Example: Au The query string to search for. |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
[- {
- "type": "municipality",
- "items": [
- {
- "id": 123,
- "text": "Wien"
}
]
}
]
List federal states for a specific country.
iso3 required | string = 3 characters Example: AUT The iso3 code of the country to list its federal states. |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
[- {
- "id": 123,
- "text": "Wien"
}
]
Search for valid zips starting with given query string.
zip required | integer [ 10 .. 9999 ] Example: 10 The zip or partial zip to query for. |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
[- 1010
]
This API method allows you to search a list of ZIP codes by specifying one or more parameters.
At least one parameter must be provided for the search to be valid.
Each parameter can accept one or more values.
If multiple parameters are provided, or if a single parameter has multiple values,
the search results will include any ZIP codes that match at least one of the provided parameters or values.
In other words, the parameters and their values are OR-related.
city_id | string Example: city_id=17228,17229 comma-separated list of integers |
municipality_id | string Example: municipality_id=90001 comma-separated list of integers |
political_district_id | string Example: political_district_id=99,100 comma-separated list of integers |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
[- {
- "id": 2221,
- "code": "1040"
}, - {
- "id": 2215,
- "code": "1060"
}, - {
- "id": 2216,
- "code": "1070"
}
]
Retrieve offer information
offerId required | integer >= 1 The id of the offer |
contactId required | integer <int64> >= 1 The id of the contact |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "offer_id": 5756,
- "contact": {
- "id": 5756
}, - "tenant_id": 5,
- "sender": {
- "id": 5756,
- "prefix": "Dr.",
- "first_name": "Justine",
- "last_name": "Immo",
- "gender": "female",
- "date_of_birth": "1971-03-27",
- "suffix": "MBA",
- "email": "support@justimmo.at",
- "phone": "0123 4567890",
- "phone_mobile": "0123 4567890",
- "phone_business": "0123 4567890",
- "phone_fax": "0123 4567890",
- "profile_picture": {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg",
- "filename": "file.jpg",
- "title": "Example File Description"
}, - "position": "string",
- "immobiliencard_id": "AT01234567",
- "immobiliencard_uid": "string",
- "foreign_id": 1234,
- "role": "employee",
- "permissions": {
- "realty_module_enabled": true,
- "realty_create": true,
- "realty_view": "own",
- "realty_view_vendors": "own",
- "realty_view_internal_files": "own",
- "realty_edit": "own",
- "realty_delete": "own",
- "realty_export": "own",
- "contact_module_enabled": true,
- "contact_create": true,
- "contact_view": "own",
- "contact_edit": "own",
- "contact_delete": "own"
}, - "tenant": {
- "id": 123,
- "name": "Justimmo",
- "email": "support@justimmo.at",
- "phone": "+43 1 2345678",
- "address": {
- "street": "Mariahilferstraße 8/11",
- "zip": "1070",
- "city": "Wien",
- "country": "AT"
}
}
}, - "created_at": "2020-05-01T12:13:25+00:00",
- "send_start": "2020-05-01T12:13:25+00:00",
- "send_end": "2020-05-01T12:13:25+00:00",
- "urls": {
}, - "state": {
- "send_state": "new",
- "spam_complaint": true,
- "mail_opened": "unknown",
- "weboffer_visit_counter": 0,
- "commission_instructed": true,
- "commission_accepted": true,
- "commission_accepted_at": "2020-05-01T12:13:25+00:00",
- "weboffer_reminder_state": "inactive"
}, - "settings": {
- "type": "offer",
- "is_weboffer": true,
- "is_commission_assurance": true,
- "is_automated": true,
- "with_prices": true,
- "with_links": true,
- "with_address": true,
- "culture": "de"
}, - "realties": [
- {
- "id": 123,
- "sub_realty_ids": [
- 123
], - "documents": [
- {
- "type": "document",
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "original_filename": "Nebenkostenübersicht.pdf",
- "title": "Nebenkostenübersicht",
- "description": "Nebenkostenübersicht zum Objekt",
- "sort_order": 13,
- "visibility": "public",
- "active": true,
- "group": {
- "id": 0
}, - "original_filesize": 0,
- "mime_type": "application/pdf",
- "uploaded_at": "1985-04-12 14:12:12"
}
]
}
], - "attachments": [
- {
- "type": "document",
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "original_filename": "Nebenkostenübersicht.pdf",
- "title": "Nebenkostenübersicht",
- "description": "Nebenkostenübersicht zum Objekt",
- "sort_order": 13,
- "visibility": "public",
- "active": true,
- "group": {
- "id": 0
}, - "original_filesize": 0,
- "mime_type": "application/pdf",
- "uploaded_at": "1985-04-12 14:12:12"
}
], - "documents": [
- {
- "type": "document",
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "original_filename": "Nebenkostenübersicht.pdf",
- "title": "Nebenkostenübersicht",
- "description": "Nebenkostenübersicht zum Objekt",
- "sort_order": 13,
- "visibility": "public",
- "active": true,
- "group": {
- "id": 0
}, - "original_filesize": 0,
- "mime_type": "application/pdf",
- "uploaded_at": "1985-04-12 14:12:12"
}
], - "texts": {
- "subject": "string",
- "text": "string"
}, - "commission_assurance": {
- "salutation": "string",
- "teaser": "string",
- "text": "string",
- "mail_subject": "string",
- "mail_text": "string"
}
}
Retrieve offer attachment content for files listed in attachments
offerId required | integer >= 1 The id of the offer |
contactId required | integer <int64> >= 1 The id of the contact |
storageKey required | string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+ The storageKey of the file |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "title": "An error occurred",
- "status": "4xx",
- "detail": "Example Error"
}
Retrieve list of search profiles for a contact
contactId required | integer <int64> >= 1 The id of the contact |
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
locale | string = 2 characters Example: locale=de |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
[- {
- "id": 5756,
- "contact": {
- "id": 5756
}, - "agent": {
- "id": 6789
}, - "creator": {
- "id": 5756
}, - "created_at": "2023-05-01T12:13:25+00:00",
- "updated_at": "2023-05-01T12:13:25+00:00",
- "expires_at": "2024-05-01",
- "search_contract": true,
- "search_contract_accepted_at": "2023-07-12T12:28:23+00:00",
- "state": "active",
- "auto_description": "Kauf, Wohnfl.: 73 m² bis 137 m², Bezirk: Wien 3., Landstraße, Wohnung",
- "notes": "string",
- "criteria": {
- "types": [
- {
- "id": 8,
- "name": "Industrie / Gewerbe",
- "openimmo_key": "hallen_lager_prod"
}
], - "subtypes": [
- {
- "id": 80,
- "name": "Hochregallager",
- "openimmo_key": "HOCHREGALLAGER"
}
], - "occupancy": "residential",
- "marketing_type": "buy",
- "rent_duration": {
- "from": 0,
- "unlimited": true
}, - "price": {
- "from": 3,
- "to": 4
}, - "price_per_area": {
- "from": 1234.56,
- "to": 1234.56
}, - "rooms": {
- "from": 3,
- "to": 4
}, - "yield": {
- "from": 0.1
}, - "site_area": {
- "from": 50,
- "to": 150
}, - "living_area": {
- "from": 50,
- "to": 150
}, - "floor_area": {
- "from": 50,
- "to": 150
}, - "office_area": {
- "from": 50,
- "to": 150
}, - "sales_area": {
- "from": 50,
- "to": 150
}, - "storage_area": {
- "from": 50,
- "to": 150
}, - "commission_free": true,
- "location": {
- "location_ids": [
- {
- "type": "federal_state",
- "id": 123,
- "text": "Wien"
}
]
}, - "architecture": "new",
- "year_of_construction": {
- "from": 3,
- "to": 4
}, - "conditions": [
- {
- "id": 1234,
- "name": "baufällig"
}
], - "floor": "ground",
- "energy_performance_class": "C",
- "category_ids": [
- 123
], - "furnishings": [
- {
- "id": 1234,
- "name": "Kochnische"
}
], - "covered_balcony": {
- "enabled": true,
- "from": 17
}, - "balcony": {
- "enabled": true,
- "from": 17
}, - "terrace": {
- "enabled": true,
- "from": 17
}, - "garden": {
- "enabled": true,
- "from": 17
}, - "accessible": true,
- "features": [
- {
- "group_label": "Boden",
- "items": [
- {
- "id": 1,
- "label": "Dielen"
}, - {
- "id": 2,
- "label": "Doppelboden"
}, - {
- "id": 1234,
- "label": "Spezialstahl",
- "tenant_id": 123
}
]
}, - {
- "group_label": "Befeuerung",
- "items": [
- {
- "id": 11,
- "label": "Elektro"
}, - {
- "id": 12,
- "label": "Erdwärme"
}, - {
- "id": 5678,
- "label": "Nuklear",
- "tenant_id": 123
}
]
}
]
}, - "automatic_hits": true
}
]
Retrieve hitlist for a contact
Hits are generated based on the users search profiles, but are not specific to them.
contactId required | integer <int64> >= 1 The id of the contact |
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
locale | string = 2 characters Example: locale=de |
offset | integer >= 0 Default: 0 Skip the first |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "realty": {
- "id": 1234
}, - "search_profiles": [
- {
- "data": {
- "id": 23,
- "auto_description": "Kauf, Wohnfl.: 73 m² bis 137 m², Bezirk: Wien 3., Landstraße, Wohnung"
}
}
], - "created_at": "1985-04-12 14:12:12"
}
]
}
Retrieve information about a hitlist entry
contactId required | integer <int64> >= 1 The id of the contact |
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "contact": {
- "id": 5756
}, - "realty": {
- "id": 1234
}, - "search_profiles": [
- {
- "data": {
- "id": 23,
- "auto_description": "Kauf, Wohnfl.: 73 m² bis 137 m², Bezirk: Wien 3., Landstraße, Wohnung"
}
}
], - "created_at": "1985-04-12 14:12:12"
}
Create an new search profile
X-Justimmo-Actor | string Default: contact Enum: "agent" "contact" This header allows you to specify if this request acts on behalf of a contact (default behaviour) or an agent. |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
contact_id required | integer <int64> |
agent_id required | integer <int64> The |
creator_id | integer <int64> Deprecated Has to be either the same as If no |
expires_in required | integer or null Enum: 3 6 12 24 36 Months until expiration |
notes | string |
created_at | string <date-time> (WriteCreatedAt) RFC-3339 If no |
required | object (CreateSearchProfileCriteria) Criteria for potential matches |
automatic_hits | boolean Default: false |
{- "contact_id": 5756,
- "agent_id": 5756,
- "creator_id": 5756,
- "expires_in": 3,
- "notes": "string",
- "created_at": "2020-05-01T12:13:25+00:00",
- "criteria": {
- "type_ids": [
- 8,
- 9
], - "subtype_ids": [
- 5,
- 7
], - "occupancy": "residential",
- "marketing_type": "buy",
- "rent_duration": {
- "from": 0,
- "unlimited": true
}, - "price": {
- "from": 3,
- "to": 4
}, - "price_per_area": {
- "from": 1234.56,
- "to": 1234.56
}, - "rooms": {
- "from": 3,
- "to": 4
}, - "yield": {
- "from": 0.1
}, - "site_area": {
- "from": 50,
- "to": 150
}, - "living_area": {
- "from": 50,
- "to": 150
}, - "floor_area": {
- "from": 50,
- "to": 150
}, - "office_area": {
- "from": 50,
- "to": 150
}, - "sales_area": {
- "from": 50,
- "to": 150
}, - "storage_area": {
- "from": 50,
- "to": 150
}, - "commission_free": true,
- "location": {
- "location_ids": [
- {
- "type": "federal_state",
- "id": 123
}
]
}, - "architecture": "new",
- "year_of_construction": {
- "from": 3,
- "to": 4
}, - "condition_ids": [
- 1,
- 2,
- 1234,
- 11,
- 12,
- 5678
], - "floor": "ground",
- "energy_performance_class": "C",
- "category_ids": [
- 123
], - "furnishing_ids": [
- 1,
- 2,
- 17
], - "covered_balcony": {
- "enabled": true,
- "from": 17
}, - "balcony": {
- "enabled": true,
- "from": 17
}, - "terrace": {
- "enabled": true,
- "from": 17
}, - "garden": {
- "enabled": true,
- "from": 17
}, - "accessible": true,
- "feature_ids": [
- 1,
- 2,
- 1234,
- 11,
- 12,
- 5678
]
}, - "automatic_hits": false
}
{- "id": 763425
}
Update an existing search profile
searchProfileId required | integer >= 1 The id of the search profile |
X-Justimmo-Actor | string Default: contact Enum: "agent" "contact" This header allows you to specify if this request acts on behalf of a contact (default behaviour) or an agent. |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
contact_id | integer <int64> |
agent_id | integer <int64> |
expires_in | integer or null Enum: 3 6 12 24 36 Months until expiration. This does not extend the expiration date ( |
extend_expiration | boolean Deprecated
This property has been deprecated in favour of the [Extend Search Profile Call](#tag/searchprofile/operation/ExtendSearchProfile).
However, if the `X-Justimmo-Actor`-Header is set to `contact` in this call, the search profile will be automatically extended and no extra call to extend it is necessary.
|
notes | string |
object (UpdateSearchProfileCriteria) Criteria for potential matches | |
automatic_hits | boolean |
{- "contact_id": 5756,
- "agent_id": 5756,
- "expires_in": 3,
- "extend_expiration": true,
- "notes": "string",
- "criteria": {
- "type_ids": [
- 8,
- 9
], - "subtype_ids": [
- 5,
- 7
], - "occupancy": "residential",
- "marketing_type": "buy",
- "rent_duration": {
- "from": 0,
- "unlimited": true
}, - "price": {
- "from": 3,
- "to": 4
}, - "price_per_area": {
- "from": 1234.56,
- "to": 1234.56
}, - "rooms": {
- "from": 3,
- "to": 4
}, - "yield": {
- "from": 0.1
}, - "site_area": {
- "from": 50,
- "to": 150
}, - "living_area": {
- "from": 50,
- "to": 150
}, - "floor_area": {
- "from": 50,
- "to": 150
}, - "office_area": {
- "from": 50,
- "to": 150
}, - "sales_area": {
- "from": 50,
- "to": 150
}, - "storage_area": {
- "from": 50,
- "to": 150
}, - "commission_free": true,
- "location": {
- "location_ids": [
- {
- "type": "federal_state",
- "id": 123
}
]
}, - "architecture": "new",
- "year_of_construction": {
- "from": 3,
- "to": 4
}, - "condition_ids": [
- 1,
- 2,
- 1234,
- 11,
- 12,
- 5678
], - "floor": "ground",
- "energy_performance_class": "C",
- "category_ids": [
- 123
], - "furnishing_ids": [
- 1,
- 2,
- 17
], - "covered_balcony": {
- "enabled": true,
- "from": 17
}, - "balcony": {
- "enabled": true,
- "from": 17
}, - "terrace": {
- "enabled": true,
- "from": 17
}, - "garden": {
- "enabled": true,
- "from": 17
}, - "accessible": true,
- "feature_ids": [
- 1,
- 2,
- 1234,
- 11,
- 12,
- 5678
]
}, - "automatic_hits": true
}
{ }
Retrieve search profile information
searchProfileId required | integer >= 1 The id of the search profile |
locale | string = 2 characters Example: locale=de |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "id": 5756,
- "contact": {
- "id": 5756
}, - "agent": {
- "id": 6789
}, - "creator": {
- "id": 5756
}, - "created_at": "2023-05-01T12:13:25+00:00",
- "updated_at": "2023-05-01T12:13:25+00:00",
- "expires_at": "2024-05-01",
- "search_contract": true,
- "search_contract_accepted_at": "2023-07-12T12:28:23+00:00",
- "state": "active",
- "auto_description": "Kauf, Wohnfl.: 73 m² bis 137 m², Bezirk: Wien 3., Landstraße, Wohnung",
- "notes": "string",
- "criteria": {
- "types": [
- {
- "id": 8,
- "name": "Industrie / Gewerbe",
- "openimmo_key": "hallen_lager_prod"
}
], - "subtypes": [
- {
- "id": 80,
- "name": "Hochregallager",
- "openimmo_key": "HOCHREGALLAGER"
}
], - "occupancy": "residential",
- "marketing_type": "buy",
- "rent_duration": {
- "from": 0,
- "unlimited": true
}, - "price": {
- "from": 3,
- "to": 4
}, - "price_per_area": {
- "from": 1234.56,
- "to": 1234.56
}, - "rooms": {
- "from": 3,
- "to": 4
}, - "yield": {
- "from": 0.1
}, - "site_area": {
- "from": 50,
- "to": 150
}, - "living_area": {
- "from": 50,
- "to": 150
}, - "floor_area": {
- "from": 50,
- "to": 150
}, - "office_area": {
- "from": 50,
- "to": 150
}, - "sales_area": {
- "from": 50,
- "to": 150
}, - "storage_area": {
- "from": 50,
- "to": 150
}, - "commission_free": true,
- "location": {
- "location_ids": [
- {
- "type": "federal_state",
- "id": 123,
- "text": "Wien"
}
]
}, - "architecture": "new",
- "year_of_construction": {
- "from": 3,
- "to": 4
}, - "conditions": [
- {
- "id": 1234,
- "name": "baufällig"
}
], - "floor": "ground",
- "energy_performance_class": "C",
- "category_ids": [
- 123
], - "furnishings": [
- {
- "id": 1234,
- "name": "Kochnische"
}
], - "covered_balcony": {
- "enabled": true,
- "from": 17
}, - "balcony": {
- "enabled": true,
- "from": 17
}, - "terrace": {
- "enabled": true,
- "from": 17
}, - "garden": {
- "enabled": true,
- "from": 17
}, - "accessible": true,
- "features": [
- {
- "group_label": "Boden",
- "items": [
- {
- "id": 1,
- "label": "Dielen"
}, - {
- "id": 2,
- "label": "Doppelboden"
}, - {
- "id": 1234,
- "label": "Spezialstahl",
- "tenant_id": 123
}
]
}, - {
- "group_label": "Befeuerung",
- "items": [
- {
- "id": 11,
- "label": "Elektro"
}, - {
- "id": 12,
- "label": "Erdwärme"
}, - {
- "id": 5678,
- "label": "Nuklear",
- "tenant_id": 123
}
]
}
]
}, - "automatic_hits": true
}
Deletes a search profile
searchProfileId required | integer >= 1 The id of the search profile |
X-Justimmo-Actor | string Default: contact Enum: "agent" "contact" This header allows you to specify if this request acts on behalf of a contact (default behaviour) or an agent. |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Activate an existing search profile
searchProfileId required | integer >= 1 The id of the search profile |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Deactivate an existing search profile
searchProfileId required | integer >= 1 The id of the search profile |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Extend an existing search profile
searchProfileId required | integer >= 1 The id of the search profile |
X-Justimmo-Actor | string Default: contact Enum: "agent" "contact" This header allows you to specify if this request acts on behalf of a contact (default behaviour) or an agent. |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Retrieve realty list
If different filter parameters are provided, those are related by AND
.
If more than one value is provided for any given filter, they are treated with an OR
relation.
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
locale | string = 2 characters Example: locale=de |
offset | integer >= 0 Default: 0 Skip the first |
object Example: filters[parent_id]=123&filters[system_type]=realty,residential_subunit | |
marketing_types[] | Array of strings (RealtyMarketingType) >= 0 items Deprecated Items Enum: "buy" "rent" Deprecated: Use Filters the results based on the realty see Value Object: RealtyMarketingType and Lookup Tables: RealtyMarketingType |
parent_ids[] | Array of integers >= 0 items Deprecated Deprecated: Use Filters the results based on the realty |
status_ids[] | Array of integers >= 0 items Deprecated Deprecated: Use Filters the results based on the realty see Value Object: RealtyStatus and Lookup Tables: RealtyStatus |
system_types[] | Array of strings (RealtySystemType) >= 0 items Deprecated Items Enum: "realty" "residential_project" "residential_subunit" "commercial_project" "commercial_area" Deprecated: Use Filters the results based on the realty see Value Object: RealtySystemType and Lookup Tables: RealtySystemType |
type_ids[] | Array of integers >= 0 items Deprecated Deprecated: Use Filters the results based on the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This allows your client to act on behalf of a specific user, adhering to the user's permissions. required only for authorization method |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "id": 5756,
- "tenant_id": 5,
- "created_at": "2020-05-01T12:13:25+00:00",
- "updated_at": "2020-05-01T12:13:25+00:00",
- "published_at": "2020-05-01T12:13:25+00:00",
- "catalogue_number": {
- "plain": 123,
- "display": "5/123"
}, - "status": {
- "id": 0,
- "name": "string",
- "until": "2020-05-01T12:13:25+00:00"
}, - "conclusion": {
- "concluded_at": "2024-05-21T10:38:59+00:00",
- "renting_from": "2024-05-21T10:38:59+00:00",
- "renting_until": "2027-05-21T10:38:59+00:00",
- "final_rent": 0.1,
- "final_rent_for_commission": 0.1
}, - "address": {
- "street": "Mariahilferstraße",
- "number": "127",
- "entrance": "5",
- "door": "3a",
- "zip": "1070",
- "city": "Wien",
- "country": "AT",
- "geo_coordinates": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "floor": "2. Etage",
- "floor_idx": 2,
- "floor_description": "2. Stock"
}, - "public_address": {
- "street": "Mariahilferstraße",
- "number": "127",
- "entrance": "5",
- "door": "3a",
- "zip": "1070",
- "city": "Wien",
- "country": "AT",
- "geo_coordinates": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "fuzzy_geo_coordinates": {
- "latitude": 0.1,
- "longitude": 0.1,
- "radius": 0
}, - "floor": "2. Etage",
- "floor_idx": 2,
- "floor_description": "2. OG"
}, - "land_registry_number": "600",
- "cadastral_municipality": "01010",
- "plot_number": "1234/1, 1234/2",
- "system_type": "realty",
- "parent_id": 5755,
- "type": {
- "id": 8,
- "name": "Industrie / Gewerbe",
- "openimmo_key": "hallen_lager_prod"
}, - "subtype": {
- "id": 80,
- "name": "Hochregallager",
- "openimmo_key": "HOCHREGALLAGER"
}, - "occupancy": {
- "residential": true,
- "commercial": true,
- "investment": true
}, - "marketing_type": "buy",
- "areas": {
- "site_area": {
- "area": 50.5
}, - "living_area": {
- "area": 50.5
}, - "floor_area": {
- "area": 50.5
}, - "developable_area": {
- "area": 50.5
}, - "office_area": {
- "area": 50.5
}, - "sales_area": {
- "area": 50.5
}, - "storage_area": {
- "area": 50.5
}, - "available_area": {
- "area": 50.5
}, - "short_term_area": {
- "area": 50.5
}, - "total_area": {
- "area": 50.5
}, - "weighted_area": {
- "area": 50.5
}, - "undeveloped_attic": true,
- "undeveloped_attic_area": {
- "area": 50.5
}, - "garden_area": {
- "area": 50.5,
- "count": 2
}, - "basement_area": {
- "area": 50.5,
- "count": 2
}, - "balcony_area": {
- "area": 50.5,
- "count": 2
}, - "terrace_area": {
- "area": 50.5,
- "count": 2
}, - "covered_balcony_area": {
- "area": 50.5,
- "count": 2
}, - "garage_area": {
- "area": 50.5,
- "count": 2
}, - "parking_space_area": {
- "area": 50.5,
- "count": 2
}
}, - "rooms": {
- "rooms": 4.5,
- "toilets": 3,
- "bathrooms": 2,
- "storerooms": 1
}, - "room_layout": "centrally_accessible",
- "prices": {
- "publish_prices": true,
- "purchase_price": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "rent": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "furniture_hire": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "parking": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "garage": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "operating": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "heating": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "hot_water": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "cooling": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "maintenance_funds": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "elevator": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "others": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}
}, - "earnings_per_year": {
- "currency": "EUR",
- "net": 1234.56
}, - "obtainable_from": {
- "date": "2021-06-05",
- "text": "string"
}, - "preview_image": {
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "sizes": {
}
}, - "preview_plan": {
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "sizes": {
}
}, - "categories": [
- {
- "id": 123,
- "name": "Interessent"
}
], - "custom_fields": [
- {
- "type": "boolean",
- "name": "active",
- "value": true
}
], - "active_for_export": true,
- "accessible": true,
- "contacts": [
- {
- "role": "prospect",
- "prospect_state": "reserved",
- "contact": {
- "id": 5756,
- "created_at": "2020-05-01T12:13:25+00:00",
- "updated_at": "2020-05-01T12:13:25+00:00"
}
}
], - "is_public": true,
- "texts": {
- "title": [
- {
- "value": "3-Zimmer-Wohnung mit Balkon Nähe Unterhupfing",
- "locale": "de"
}
]
}
}
]
}
Create an new realty
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
catalogue_number_plain | integer <int64> Depending on tenant settings, this value might be auto-generated and thus the property may either be required or ignored. Must be a unique, unused value |
required | object (CreateRealtyAddress) |
land_registry_number | string Deprecated Einlagezahl (EZ) Country must be Austria. Deprecated: Use Create/Update RealtyLandRegisterEntry endpoints instead or use POST Creates a new LandRegisterEntry with the values provided in land_registry_number, cadastral_municipality and plot_numbers. If neither of those values are provided, the values are determined automatically based on the realty address. PATCH Updates the land_register_entry_number of the first LandRegisterEntry or creates a new LandRegisterEntry if no entry exists yet. |
cadastral_municipality | string Deprecated Katastralgemeinde Nummer (KG-NR) Country must be Austria. Deprecated: Use Create/Update RealtyLandRegisterEntry endpoints instead or use POST Creates a new LandRegisterEntry with the values provided in land_registry_number, cadastral_municipality and plot_numbers. If neither of those values are provided, the values are determined automatically based on the realty address. PATCH Updates the cadastral_municipality_id of the first LandRegisterEntry or creates a new LandRegisterEntry if no entry exists yet. |
plot_number | string Deprecated Grundstücksnummern (GST-NR) Country must be Austria. Deprecated: Use Create/Update RealtyLandRegisterEntry endpoints instead or use POST Creates a new LandRegisterEntry with the values provided in land_registry_number, cadastral_municipality and plot_numbers. If neither of those values are provided, the values are determined automatically based on the realty address. PATCH Overwrites all plot_numbers of the first LandRegisterEntry or creates a new LandRegisterEntry if no entry exists yet. The provided value is stored as a single plot number. |
system_type required | string Enum: "realty" "residential_project" "residential_subunit" "commercial_project" "commercial_area" |
parent_id | integer <int64> The realty Id of the parent residential or commercial project Currently unused because |
type_id required | integer Objektart Id |
subtype_id | integer Subobjektart Id |
required | object Nutzungsart At least one of these must be |
marketing_type required | string (RealtyMarketingType) Enum: "buy" "rent" Vermarktungsart |
architecture | string or null (RealtyArchitecture) Enum: "new" "old" Bauart (Neubau / Altbau) |
year_of_construction | integer or null |
infrastructure_provision | string or null (RealtyInfrastructureProvision) Enum: "not_developed" "partially_developed" "fully_developed" Erschließung (Unerschlossen / Teilerschlossen / Vollerschlossen) |
year_of_last_renovation | integer or null |
year_of_last_comprehensive_renovation | integer or null |
object | |
object (RealtyFloors) | |
object or null (WriteRooms) | |
room_layout | string or null (RoomLayout) Enum: "centrally_accessible" "partly_centrally_accessible" "circularly_accessible" "loft" "centrally_accessible": zentral begehbar |
currency | string = 3 characters Enum: "EUR" "USD" "CHF" "HUF" "PLN" "RON" "AED" ISO 4217 Code Currently, only "EUR" is supported. |
object The currency for these prices is determined by the realty's | |
earnings_per_year_net | number <float> Nettoertrag pro Jahr The currency is determined by the realty's |
object POST Either | |
category_ids | Array of integers <int64> [ items <int64 > ] |
agent_id required | integer <int64> |
object (RealtyTexts) | |
object or null (InputEnergyPerformanceCertification) Energieausweis If a | |
feature_ids | Array of integers <int32> [ items <int32 > ] Ausstattungsmerkmale |
accessible | boolean Default: false barrierefrei |
vendor_economic_relationship | string or null (VendorEconomicRelationship) Enum: "none" "family_or_economic" "economic_interconnection" Naheverhältnis |
object (WriteRealtyRentDetails) | |
object (WriteCommission) | |
dual_brokerage | boolean or null (RealtyDualBrokerage) Doppelmaklertätigkeit |
condition_assessment | string or null (RealtyConditionAssessment) Enum: "very_good" "good" "medium" "bad" Zustandsbewertung |
realty_condition_id | integer or null |
building_condition_id | integer or null |
object (RealtyAgencyAgreement) | |
Array of objects (CustomField) | |
automatic_hits | boolean |
object Country must be Austria. If no data is provided, the land register entry is determined automatically based on the realty address. If this property is provided, the deprecated properties | |
created_at | string <date-time> (WriteCreatedAt) RFC-3339 If no |
ownership_type_id | integer or null (WriteOwnershipTypeId) Eigentumsform |
furnishing_id | integer or null (WriteFurnishingId) Möblierung |
noise_level_id | integer or null (WriteNoiseLevelId) Lärmpegel |
location_assessment | string or null (WriteLocationAssessment) Enum: "very good" "good" "medium" "bad" Lagebewertung |
{- "catalogue_number_plain": 123,
- "address": {
- "street": "Mariahilferstraße",
- "number": "127",
- "entrance": "5",
- "door": "3a",
- "zip": "1070",
- "city": "Wien",
- "country": "AT",
- "floor_idx": 2,
- "floor_description": "3. Stock"
}, - "land_registry_number": "600",
- "cadastral_municipality": "01010",
- "plot_number": "1234/1, 1234/2",
- "system_type": "realty",
- "parent_id": 5755,
- "type_id": 8,
- "subtype_id": 80,
- "occupancy": {
- "residential": true,
- "commercial": true,
- "investment": true
}, - "marketing_type": "buy",
- "architecture": "new",
- "year_of_construction": 0,
- "infrastructure_provision": "not_developed",
- "year_of_last_renovation": 0,
- "year_of_last_comprehensive_renovation": 0,
- "areas": {
- "site_area": {
- "area": 50.5
}, - "living_area": {
- "area": 50.5
}, - "floor_area": {
- "area": 50.5
}, - "developable_area": {
- "area": 50.5
}, - "office_area": {
- "area": 50.5
}, - "sales_area": {
- "area": 50.5
}, - "storage_area": {
- "area": 50.5
}, - "available_area": {
- "area": 50.5
}, - "short_term_area": {
- "area": 50.5
}, - "total_area": {
- "area": 50.5
}, - "weighted_area": {
- "area": 50.5
}, - "undeveloped_attic": true,
- "undeveloped_attic_area": {
- "area": 50.5
}, - "garden_area": {
- "area": 50.5,
- "count": 2
}, - "basement_area": {
- "area": 50.5,
- "count": 2
}, - "balcony_area": {
- "area": 50.5,
- "count": 2
}, - "terrace_area": {
- "area": 50.5,
- "count": 2
}, - "covered_balcony_area": {
- "area": 50.5,
- "count": 2
}, - "garage_area": {
- "area": 50.5,
- "count": 2
}, - "parking_space_area": {
- "area": 50.5,
- "count": 2
}
}, - "floors": {
- "count_floors": 0,
- "count_attic_floors": 0,
- "mezzanine": false
}, - "rooms": {
- "rooms": 4,
- "rooms_add_half": false,
- "toilets": 3,
- "bathrooms": 2,
- "storerooms": 1
}, - "room_layout": "centrally_accessible",
- "currency": "EUR",
- "prices": {
- "publish_prices": true,
- "purchase_price": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "rent": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "furniture_hire": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "parking": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "garage": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "operating": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "heating": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "hot_water": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "cooling": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "maintenance_funds": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "elevator": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "others": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}
}, - "earnings_per_year_net": 1234.56,
- "obtainable_from": {
- "date": "2021-06-05",
- "text": "string"
}, - "category_ids": [
- 123
], - "agent_id": 5756,
- "texts": {
- "label": "W-1728",
- "title": [
- {
- "value": "3-Zimmer-Wohnung mit Balkon Nähe Unterhupfing",
- "locale": "de"
}
], - "location": [
- {
- "value": "Am Rande des der Kleinstadt Unterhupfing, unweit eines schönen Badesees in einer ruhigen Nebenstraße",
- "locale": "de"
}
], - "description": [
- {
- "value": "Die Wohnung befindet sich in einer kleinen sehr ruhigen Wohnanlage in unmittelbarer Nähe zum Badesee.\n\nDer geräumige Südbalkon ist überdacht und bietet einen schönen Ausblick.",
- "locale": "de"
}
], - "description_expose": [
- {
- "value": "Die Wohnung befindet sich in einer kleinen sehr ruhigen Wohnanlage in unmittelbarer Nähe zum Badesee.\n\nDer geräumige Südbalkon ist überdacht und bietet einen schönen Ausblick.",
- "locale": "de"
}
]
}, - "energy_performance_certification": {
- "energy_performance": {
- "value": 1.67,
- "class": "C"
}, - "heating_demand": {
- "value": 95.65,
- "class": "C"
}, - "valid_until": "2022-07-18",
- "auto_disclaimer": true
}, - "feature_ids": [
- 1,
- 2,
- 1234,
- 11,
- 12,
- 5678
], - "accessible": false,
- "vendor_economic_relationship": "none",
- "rent_details": {
- "costs": {
- "buyout": 0,
- "security_deposit": {
- "value": 3,
- "type": "monthly_rent_gross_text",
- "auto_text": true,
- "text": "3 Bruttomonatsmieten"
}, - "financing_contribution": 0,
- "explanation": "string",
- "stamp_duty": {
- "auto_value": true,
- "value": null,
- "text": "string"
}
}, - "purchase_option": false
}, - "commission": {
- "prospect": {
- "principle_of_first_instruction": true,
- "type": "percentage_value",
- "value": 3,
- "vat": 20,
- "auto_text": false,
- "text_value": "3% des Kaufpreises zzgl. 20% USt."
}, - "vendor": {
- "type": "percentage",
- "value": 3,
- "vat": 20
}
}, - "dual_brokerage": true,
- "condition_assessment": "very_good",
- "realty_condition_id": 0,
- "building_condition_id": 0,
- "agency_agreement": {
- "valid_from": "2021-06-05",
- "valid_until": "2021-06-05",
- "agency_agreement_type": "sole_agency_agreement",
- "agreement_method": "verbal",
- "business_opportunity_knowledge_date": "2021-06-05"
}, - "custom_fields": [
- {
- "type": "boolean",
- "name": "active",
- "value": true
}
], - "automatic_hits": true,
- "land_register_entry": {
- "land_register_entry_number": "600",
- "cadastral_municipality_id": "01010",
- "plot_numbers": [
- "274"
], - "owner_sequence_numbers": [
- 3
]
}, - "created_at": "2020-05-01T12:13:25+00:00",
- "ownership_type_id": 2,
- "furnishing_id": 2,
- "noise_level_id": 2,
- "location_assessment": "very good"
}
{- "id": 939482,
- "catalogue_number": {
- "plain": 123,
- "display": "5/123"
}
}
Update an existing realty
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
catalogue_number_plain | integer <int64> Depending on tenant settings, this value might be auto-generated and thus the property may either be required or ignored. Must be a unique, unused value |
object (UpdateRealtyAddress) | |
land_registry_number | string Deprecated Einlagezahl (EZ) Country must be Austria. Deprecated: Use Create/Update RealtyLandRegisterEntry endpoints instead or use POST Creates a new LandRegisterEntry with the values provided in land_registry_number, cadastral_municipality and plot_numbers. If neither of those values are provided, the values are determined automatically based on the realty address. PATCH Updates the land_register_entry_number of the first LandRegisterEntry or creates a new LandRegisterEntry if no entry exists yet. |
cadastral_municipality | string Deprecated Katastralgemeinde Nummer (KG-NR) Country must be Austria. Deprecated: Use Create/Update RealtyLandRegisterEntry endpoints instead or use POST Creates a new LandRegisterEntry with the values provided in land_registry_number, cadastral_municipality and plot_numbers. If neither of those values are provided, the values are determined automatically based on the realty address. PATCH Updates the cadastral_municipality_id of the first LandRegisterEntry or creates a new LandRegisterEntry if no entry exists yet. |
plot_number | string Deprecated Grundstücksnummern (GST-NR) Country must be Austria. Deprecated: Use Create/Update RealtyLandRegisterEntry endpoints instead or use POST Creates a new LandRegisterEntry with the values provided in land_registry_number, cadastral_municipality and plot_numbers. If neither of those values are provided, the values are determined automatically based on the realty address. PATCH Overwrites all plot_numbers of the first LandRegisterEntry or creates a new LandRegisterEntry if no entry exists yet. The provided value is stored as a single plot number. |
system_type | string Enum: "realty" "residential_project" "residential_subunit" "commercial_project" "commercial_area" |
parent_id | integer <int64> The realty Id of the parent residential or commercial project Currently unused because |
type_id | integer Objektart Id |
subtype_id | integer Subobjektart Id |
object Nutzungsart At least one of these must be | |
marketing_type | string (RealtyMarketingType) Enum: "buy" "rent" Vermarktungsart |
architecture | string or null (RealtyArchitecture) Enum: "new" "old" Bauart (Neubau / Altbau) |
year_of_construction | integer or null |
infrastructure_provision | string or null (RealtyInfrastructureProvision) Enum: "not_developed" "partially_developed" "fully_developed" Erschließung (Unerschlossen / Teilerschlossen / Vollerschlossen) |
year_of_last_renovation | integer or null |
year_of_last_comprehensive_renovation | integer or null |
object | |
object (RealtyFloors) | |
object or null (WriteRooms) | |
room_layout | string or null (RoomLayout) Enum: "centrally_accessible" "partly_centrally_accessible" "circularly_accessible" "loft" "centrally_accessible": zentral begehbar |
currency | string = 3 characters Enum: "EUR" "USD" "CHF" "HUF" "PLN" "RON" "AED" ISO 4217 Code Currently, only "EUR" is supported. |
object The currency for these prices is determined by the realty's | |
earnings_per_year_net | number or null <float> Nettoertrag pro Jahr The currency is determined by the realty's |
object POST Either | |
category_ids | Array of integers <int64> [ items <int64 > ] |
agent_id | integer <int64> |
object (RealtyTexts) | |
object or null (InputEnergyPerformanceCertification) Energieausweis If a | |
feature_ids | Array of integers <int32> [ items <int32 > ] Ausstattungsmerkmale |
accessible | boolean Default: false barrierefrei |
vendor_economic_relationship | string or null (VendorEconomicRelationship) Enum: "none" "family_or_economic" "economic_interconnection" Naheverhältnis |
object (WriteRealtyRentDetails) | |
object (WriteCommission) | |
dual_brokerage | boolean or null (RealtyDualBrokerage) Doppelmaklertätigkeit |
condition_assessment | string or null (RealtyConditionAssessment) Enum: "very_good" "good" "medium" "bad" Zustandsbewertung |
realty_condition_id | integer or null |
building_condition_id | integer or null |
object (RealtyAgencyAgreement) | |
Array of objects (CustomField) | |
automatic_hits | boolean |
ownership_type_id | integer or null (WriteOwnershipTypeId) Eigentumsform |
furnishing_id | integer or null (WriteFurnishingId) Möblierung |
noise_level_id | integer or null (WriteNoiseLevelId) Lärmpegel |
location_assessment | string or null (WriteLocationAssessment) Enum: "very good" "good" "medium" "bad" Lagebewertung |
{- "catalogue_number_plain": 123,
- "address": {
- "street": "Mariahilferstraße",
- "number": "127",
- "entrance": "5",
- "door": "3a",
- "zip": "1070",
- "city": "Wien",
- "country": "AT",
- "floor_idx": 2,
- "floor_description": "3. Stock"
}, - "land_registry_number": "600",
- "cadastral_municipality": "01010",
- "plot_number": "1234/1, 1234/2",
- "system_type": "realty",
- "parent_id": 5755,
- "type_id": 8,
- "subtype_id": 80,
- "occupancy": {
- "residential": true,
- "commercial": true,
- "investment": true
}, - "marketing_type": "buy",
- "architecture": "new",
- "year_of_construction": 0,
- "infrastructure_provision": "not_developed",
- "year_of_last_renovation": 0,
- "year_of_last_comprehensive_renovation": 0,
- "areas": {
- "site_area": {
- "area": 50.5
}, - "living_area": {
- "area": 50.5
}, - "floor_area": {
- "area": 50.5
}, - "developable_area": {
- "area": 50.5
}, - "office_area": {
- "area": 50.5
}, - "sales_area": {
- "area": 50.5
}, - "storage_area": {
- "area": 50.5
}, - "available_area": {
- "area": 50.5
}, - "short_term_area": {
- "area": 50.5
}, - "total_area": {
- "area": 50.5
}, - "weighted_area": {
- "area": 50.5
}, - "undeveloped_attic": true,
- "undeveloped_attic_area": {
- "area": 50.5
}, - "garden_area": {
- "area": 50.5,
- "count": 2
}, - "basement_area": {
- "area": 50.5,
- "count": 2
}, - "balcony_area": {
- "area": 50.5,
- "count": 2
}, - "terrace_area": {
- "area": 50.5,
- "count": 2
}, - "covered_balcony_area": {
- "area": 50.5,
- "count": 2
}, - "garage_area": {
- "area": 50.5,
- "count": 2
}, - "parking_space_area": {
- "area": 50.5,
- "count": 2
}
}, - "floors": {
- "count_floors": 0,
- "count_attic_floors": 0,
- "mezzanine": false
}, - "rooms": {
- "rooms": 4,
- "rooms_add_half": false,
- "toilets": 3,
- "bathrooms": 2,
- "storerooms": 1
}, - "room_layout": "centrally_accessible",
- "currency": "EUR",
- "prices": {
- "publish_prices": true,
- "purchase_price": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "rent": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "furniture_hire": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "parking": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "garage": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "operating": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "heating": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "hot_water": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "cooling": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "maintenance_funds": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}, - "elevator": {
- "net": 1234.56,
- "vat": {
- "value": 123.45,
- "type": "absolute"
}, - "optional": true
}, - "others": {
- "net": 1234.56,
- "vat": {
- "value": 20,
- "type": "absolute"
}
}
}, - "earnings_per_year_net": 1234.56,
- "obtainable_from": {
- "date": "2021-06-05",
- "text": "string"
}, - "category_ids": [
- 123
], - "agent_id": 5756,
- "texts": {
- "label": "W-1728",
- "title": [
- {
- "value": "3-Zimmer-Wohnung mit Balkon Nähe Unterhupfing",
- "locale": "de"
}
], - "location": [
- {
- "value": "Am Rande des der Kleinstadt Unterhupfing, unweit eines schönen Badesees in einer ruhigen Nebenstraße",
- "locale": "de"
}
], - "description": [
- {
- "value": "Die Wohnung befindet sich in einer kleinen sehr ruhigen Wohnanlage in unmittelbarer Nähe zum Badesee.\n\nDer geräumige Südbalkon ist überdacht und bietet einen schönen Ausblick.",
- "locale": "de"
}
], - "description_expose": [
- {
- "value": "Die Wohnung befindet sich in einer kleinen sehr ruhigen Wohnanlage in unmittelbarer Nähe zum Badesee.\n\nDer geräumige Südbalkon ist überdacht und bietet einen schönen Ausblick.",
- "locale": "de"
}
]
}, - "energy_performance_certification": {
- "energy_performance": {
- "value": 1.67,
- "class": "C"
}, - "heating_demand": {
- "value": 95.65,
- "class": "C"
}, - "valid_until": "2022-07-18",
- "auto_disclaimer": true
}, - "feature_ids": [
- 1,
- 2,
- 1234,
- 11,
- 12,
- 5678
], - "accessible": false,
- "vendor_economic_relationship": "none",
- "rent_details": {
- "costs": {
- "buyout": 0,
- "security_deposit": {
- "value": 3,
- "type": "monthly_rent_gross_text",
- "auto_text": true,
- "text": "3 Bruttomonatsmieten"
}, - "financing_contribution": 0,
- "explanation": "string",
- "stamp_duty": {
- "auto_value": true,
- "value": null,
- "text": "string"
}
}, - "purchase_option": false
}, - "commission": {
- "prospect": {
- "principle_of_first_instruction": true,
- "type": "percentage_value",
- "value": 3,
- "vat": 20,
- "auto_text": false,
- "text_value": "3% des Kaufpreises zzgl. 20% USt."
}, - "vendor": {
- "type": "percentage",
- "value": 3,
- "vat": 20
}
}, - "dual_brokerage": true,
- "condition_assessment": "very_good",
- "realty_condition_id": 0,
- "building_condition_id": 0,
- "agency_agreement": {
- "valid_from": "2021-06-05",
- "valid_until": "2021-06-05",
- "agency_agreement_type": "sole_agency_agreement",
- "agreement_method": "verbal",
- "business_opportunity_knowledge_date": "2021-06-05"
}, - "custom_fields": [
- {
- "type": "boolean",
- "name": "active",
- "value": true
}
], - "automatic_hits": true,
- "ownership_type_id": 2,
- "furnishing_id": 2,
- "noise_level_id": 2,
- "location_assessment": "very good"
}
{ }
Retrieve realty information
realtyId required | integer <int64> >= 1 The id of the realty |
locale | string = 2 characters Example: locale=de |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "id": 5756,
- "tenant_id": 5,
- "created_at": "2020-05-01T12:13:25+00:00",
- "updated_at": "2020-05-01T12:13:25+00:00",
- "published_at": "2020-05-01T12:13:25+00:00",
- "catalogue_number": {
- "plain": 123,
- "display": "5/123"
}, - "status": {
- "id": 0,
- "name": "string",
- "until": "2020-05-01T12:13:25+00:00"
}, - "conclusion": {
- "concluded_at": "2024-05-21T10:38:59+00:00",
- "renting_from": "2024-05-21T10:38:59+00:00",
- "renting_until": "2027-05-21T10:38:59+00:00",
- "final_rent": 0.1,
- "final_rent_for_commission": 0.1
}, - "address": {
- "street": "Mariahilferstraße",
- "number": "127",
- "entrance": "5",
- "door": "3a",
- "zip": "1070",
- "city": "Wien",
- "country": "AT",
- "geo_coordinates": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "floor": "2. Etage",
- "floor_idx": 2,
- "floor_description": "2. Stock"
}, - "public_address": {
- "street": "Mariahilferstraße",
- "number": "127",
- "entrance": "5",
- "door": "3a",
- "zip": "1070",
- "city": "Wien",
- "country": "AT",
- "geo_coordinates": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "fuzzy_geo_coordinates": {
- "latitude": 0.1,
- "longitude": 0.1,
- "radius": 0
}, - "floor": "2. Etage",
- "floor_idx": 2,
- "floor_description": "2. OG"
}, - "land_registry_number": "600",
- "cadastral_municipality": "01010",
- "plot_number": "1234/1, 1234/2",
- "system_type": "realty",
- "parent_id": 5755,
- "type": {
- "id": 8,
- "name": "Industrie / Gewerbe",
- "openimmo_key": "hallen_lager_prod"
}, - "subtype": {
- "id": 80,
- "name": "Hochregallager",
- "openimmo_key": "HOCHREGALLAGER"
}, - "occupancy": {
- "residential": true,
- "commercial": true,
- "investment": true
}, - "marketing_type": "buy",
- "architecture": "new",
- "year_of_construction": 0,
- "infrastructure_provision": "not_developed",
- "year_of_last_renovation": 0,
- "year_of_last_comprehensive_renovation": 0,
- "areas": {
- "site_area": {
- "area": 50.5
}, - "living_area": {
- "area": 50.5
}, - "floor_area": {
- "area": 50.5
}, - "developable_area": {
- "area": 50.5
}, - "office_area": {
- "area": 50.5
}, - "sales_area": {
- "area": 50.5
}, - "storage_area": {
- "area": 50.5
}, - "available_area": {
- "area": 50.5
}, - "short_term_area": {
- "area": 50.5
}, - "total_area": {
- "area": 50.5
}, - "weighted_area": {
- "area": 50.5
}, - "undeveloped_attic": true,
- "undeveloped_attic_area": {
- "area": 50.5
}, - "garden_area": {
- "area": 50.5,
- "count": 2
}, - "basement_area": {
- "area": 50.5,
- "count": 2
}, - "balcony_area": {
- "area": 50.5,
- "count": 2
}, - "terrace_area": {
- "area": 50.5,
- "count": 2
}, - "covered_balcony_area": {
- "area": 50.5,
- "count": 2
}, - "garage_area": {
- "area": 50.5,
- "count": 2
}, - "parking_space_area": {
- "area": 50.5,
- "count": 2
}
}, - "floors": {
- "count_floors": 0,
- "count_attic_floors": 0,
- "mezzanine": false
}, - "rooms": {
- "rooms": 4.5,
- "toilets": 3,
- "bathrooms": 2,
- "storerooms": 1
}, - "room_layout": "centrally_accessible",
- "prices": {
- "publish_prices": true,
- "purchase_price": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "rent": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "furniture_hire": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "parking": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "garage": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "operating": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "heating": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "hot_water": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "cooling": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "maintenance_funds": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "elevator": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}, - "others": {
- "currency": "EUR",
- "net": 1234.56,
- "gross": 1481.47,
- "vat_absolute": 246.91,
- "vat_percentage": 20
}
}, - "earnings_per_year": {
- "currency": "EUR",
- "net": 1234.56
}, - "obtainable_from": {
- "date": "2021-06-05",
- "text": "string"
}, - "preview_image": {
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "sizes": {
}
}, - "preview_plan": {
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "sizes": {
}
}, - "categories": [
- {
- "id": 123,
- "name": "Interessent"
}
], - "custom_fields": [
- {
- "type": "boolean",
- "name": "active",
- "value": true
}
], - "agent": {
- "id": 5756,
- "prefix": "Dr.",
- "first_name": "Justine",
- "last_name": "Immo",
- "gender": "female",
- "date_of_birth": "1971-03-27",
- "suffix": "MBA",
- "email": "support@justimmo.at",
- "phone": "0123 4567890",
- "phone_mobile": "0123 4567890",
- "phone_business": "0123 4567890",
- "phone_fax": "0123 4567890",
- "profile_picture": {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg",
- "filename": "file.jpg",
- "title": "Example File Description"
}, - "position": "string",
- "immobiliencard_id": "AT01234567",
- "immobiliencard_uid": "string",
- "foreign_id": 1234,
- "role": "employee",
- "permissions": {
- "realty_module_enabled": true,
- "realty_create": true,
- "realty_view": "own",
- "realty_view_vendors": "own",
- "realty_view_internal_files": "own",
- "realty_edit": "own",
- "realty_delete": "own",
- "realty_export": "own",
- "contact_module_enabled": true,
- "contact_create": true,
- "contact_view": "own",
- "contact_edit": "own",
- "contact_delete": "own"
}, - "tenant": {
- "id": 123,
- "name": "Justimmo",
- "email": "support@justimmo.at",
- "phone": "+43 1 2345678",
- "address": {
- "street": "Mariahilferstraße 8/11",
- "zip": "1070",
- "city": "Wien",
- "country": "AT"
}
}
}, - "active_for_export": true,
- "accessible": true,
- "contacts": [
- {
- "role": "prospect",
- "prospect_state": "reserved",
- "contact": {
- "id": 5756,
- "created_at": "2020-05-01T12:13:25+00:00",
- "updated_at": "2020-05-01T12:13:25+00:00"
}
}
], - "files": [
- {
- "type": "document",
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "original_filename": "Nebenkostenübersicht.pdf",
- "title": "Nebenkostenübersicht",
- "description": "Nebenkostenübersicht zum Objekt",
- "sort_order": 13,
- "visibility": "public",
- "active": true,
- "group": {
- "id": 0
}, - "original_filesize": 0,
- "mime_type": "application/pdf",
- "uploaded_at": "1985-04-12 14:12:12"
}
], - "internal_files": [
- {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg",
- "filename": "file.jpg",
- "title": "Example File Description"
}
], - "texts": {
- "label": "W-1728",
- "title": [
- {
- "value": "3-Zimmer-Wohnung mit Balkon Nähe Unterhupfing",
- "locale": "de"
}
], - "location": [
- {
- "value": "Am Rande des der Kleinstadt Unterhupfing, unweit eines schönen Badesees in einer ruhigen Nebenstraße",
- "locale": "de"
}
], - "description": [
- {
- "value": "Die Wohnung befindet sich in einer kleinen sehr ruhigen Wohnanlage in unmittelbarer Nähe zum Badesee.\n\nDer geräumige Südbalkon ist überdacht und bietet einen schönen Ausblick.",
- "locale": "de"
}
], - "description_expose": [
- {
- "value": "Die Wohnung befindet sich in einer kleinen sehr ruhigen Wohnanlage in unmittelbarer Nähe zum Badesee.\n\nDer geräumige Südbalkon ist überdacht und bietet einen schönen Ausblick.",
- "locale": "de"
}
]
}, - "energy_performance_certification": {
- "energy_performance": {
- "value": 1.67,
- "class": "C"
}, - "heating_demand": {
- "value": 95.65,
- "class": "C"
}, - "valid_until": "2022-07-18",
- "auto_disclaimer": false
}, - "features": [
- {
- "group_label": "Boden",
- "items": [
- {
- "id": 1,
- "label": "Dielen"
}, - {
- "id": 2,
- "label": "Doppelboden"
}, - {
- "id": 1234,
- "label": "Spezialstahl",
- "tenant_id": 123
}
]
}, - {
- "group_label": "Befeuerung",
- "items": [
- {
- "id": 11,
- "label": "Elektro"
}, - {
- "id": 12,
- "label": "Erdwärme"
}, - {
- "id": 5678,
- "label": "Nuklear",
- "tenant_id": 123
}
]
}
], - "links": [
- {
- "id": 0,
- "description": "Online 3D Rundgang",
- "type": "tour",
- "export": {
- "offer": true,
- "platform": true,
- "website": true,
- "other": true
}
}
], - "residential_aggregation_data": {
- "area": {
- "from": 52.1,
- "to": 178.93
}, - "price": {
- "currency": "EUR",
- "from": 257000.99,
- "to": 939500.5
}, - "rooms": {
- "from": 2,
- "to": 5.5
}, - "subunits_available": 15
}, - "commission": {
- "prospect": {
- "principle_of_first_instruction": true,
- "value": 3,
- "type": {
- "value": "percentage_value",
- "name": "% des Kaufpreises (Wert)"
}, - "vat": 20,
- "auto_text": true,
- "text_value": "3% des Kaufpreises zzgl. 20% USt."
}, - "vendor": {
- "value": 3,
- "type": {
- "value": "percentage",
- "name": "% des Kaufpreises"
}, - "vat": 20,
- "text_value": "36.000,00 €"
}
}, - "vendor_economic_relationship": "none",
- "dual_brokerage": true,
- "condition_assessment": "very_good",
- "realty_condition": {
- "id": 0,
- "name": "string"
}, - "building_condition": {
- "id": 0,
- "name": "string"
}, - "is_public": true,
- "agency_agreement": {
- "valid_from": "2021-06-05",
- "valid_until": "2021-06-05",
- "agency_agreement_type": "sole_agency_agreement",
- "agreement_method": "verbal",
- "business_opportunity_knowledge_date": "2021-06-05"
}, - "automatic_hits": true,
- "rent_details": {
- "maximum_rental_period": 60,
- "unlimited_rental_period": false,
- "waiver_of_cancellation_period": 15,
- "deposit": "2 Bruttomonatsmieten zzgl. 20% USt.",
- "costs": {
- "buyout": 0,
- "security_deposit": {
- "value": 2.5,
- "type": "monthly_rent_gross_text",
- "auto_text": true,
- "text": "2,5 Bruttomonatsmieten"
}, - "financing_contribution": 0,
- "explanation": "string",
- "stamp_duty": {
- "auto_value": true,
- "value": 1,
- "text": "string"
}
}, - "purchase_option": true
}, - "land_register_entries": [
- {
- "id": 123,
- "land_register_entry_number": "600",
- "cadastral_municipality_id": "01010",
- "cadastral_municipality_name": "Neubau",
- "plot_numbers": [
- "274"
], - "owner_sequence_numbers": [
- 3
]
}
], - "ownership_type": {
- "id": 0,
- "name": "string"
}, - "furnishing": {
- "id": 0,
- "name": "string"
}, - "noise_level": {
- "id": 0,
- "name": "string"
}, - "location_assessment": {
- "value": "string",
- "name": "string"
}
}
Retrieve activities for a realty
If different filter parameters are provided, those are related by AND
.
If more than one value is provided for any given filter, they are treated with an OR
relation.
realtyId required | integer <int64> >= 1 The id of the realty |
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
locale | string = 2 characters Example: locale=de |
offset | integer >= 0 Default: 0 Skip the first |
object Filters the results |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "id": 575693,
- "tenant_id": 5,
- "created_at": "2020-05-01T12:13:25+00:00",
- "sort_date": "2020-05-01T12:13:25+00:00",
- "from": "2020-05-01T12:13:25+00:00",
- "to": "2020-05-01T12:13:25+00:00",
- "activity_type": {
- "id": 5756,
- "name": "Objekt erstellt"
}, - "agent": {
- "id": 5756
}, - "contact": {
- "id": 5756
}, - "realty": {
- "id": 5756
}, - "offer": {
- "id": 5756
}, - "comment": "Balkon zu klein",
- "offertext": "Sehr geehrter Herr Mustermann, [...]",
- "files": [
- {
- "type": "document",
- "storage_key": "4j9dVEXKRWNzu2a25yruVN.jpg",
- "original_filename": "Nebenkostenübersicht.pdf",
- "title": "Nebenkostenübersicht",
- "description": "Nebenkostenübersicht zum Objekt",
- "sort_order": 13,
- "visibility": "public",
- "active": true,
- "group": {
- "id": 0
}, - "original_filesize": 0,
- "mime_type": "application/pdf",
- "uploaded_at": "1985-04-12 14:12:12"
}
]
}
]
}
Retrieve an list of available export feeds for this realty and their status
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{- "active": true,
- "exports": [
- {
- "id": 43634,
- "name": "Example Platform",
- "category": {
- "value": "platform",
- "name": "Plattform"
}, - "enabled": true,
- "export_state": {
- "value": "limit_exceeded",
- "name": "Limit überschritten"
}, - "log_state": {
- "value": "online",
- "name": "übertragen"
}, - "limit": {
- "current": 11,
- "limit_soft": 5,
- "limit": 10
}, - "last_export": "2024-11-20T16:22:00+00:00"
}
]
}
toggle the status of realty exports
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
active | boolean Exporte aktivieren |
Array of objects |
{- "active": true,
- "exports": [
- {
- "id": 43634,
- "enabled": true
}
]
}
{ }
Retrieve an export log for the realty detailing at what times the realty was exported to export feeds.
realtyId required | integer <int64> >= 1 The id of the realty |
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
offset | integer >= 0 Default: 0 Skip the first |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "realty": {
- "id": 42
}, - "started_at": "2020-05-01T12:13:25+00:00",
- "stopped_at": "2020-05-05T14:10:31+00:00",
- "feed": {
- "id": 42,
- "name": "willhaben.at",
- "category": "platform"
}, - "platform": {
- "id": 6,
- "name": "willhaben.at"
}
}
]
}
Uploads a file and attaches it to the realty
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
file required | string <binary> |
title | string |
description | string |
group_id required | string\d+ The group of the file |
sort_order | string\d+ If provided, reorders the attachments of the same realty and group to fit this new file in a specific position. This can be a positive or negative value:
|
[- {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg"
}
]
Retrieve realty file content for files listed in internal_files
realtyId required | integer <int64> >= 1 The id of the realty |
storageKey required | string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+ The storageKey of the file |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "title": "An error occurred",
- "status": "4xx",
- "detail": "Example Error"
}
Deletes a file attached to a realty
realtyId required | integer <int64> >= 1 The id of the realty |
storageKey required | string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+ The storageKey of the file |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Retrieve realty expose content for exposes available for the tenant
realtyId required | integer <int64> >= 1 The id of the realty |
templateId required | integer <int64> >= 1 The ID of the Exposé template is available upon request from Justimmo Support. |
locale | string = 2 characters Example: locale=de |
showAddress | integer [ 0 .. 1 ] Forces to show the full address, otherwise it uses the realty setting. |
showPrices | integer [ 0 .. 1 ] Forces to show the prices. It works only with those Expose templates which support this feature. |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "title": "An error occurred",
- "status": "4xx",
- "detail": "Example Error"
}
Update an existing realty file's metadata
realtyId required | integer <int64> >= 1 The id of the realty |
storageKey required | string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+ The storageKey of the file |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
title | string As the title is part of the file itself, not the attachment, changing it is only allowed on files that are attached to this realty only. |
description | string As the description is part of the file itself, not the attachment, changing it is only allowed on files that are attached to this realty only. |
sort_order | integer If provided, reorders the attachments of the same realty and group to fit this new file in a specific position. This can be a positive or negative value:
|
{- "title": "string",
- "description": "string",
- "sort_order": 0
}
{ }
Start marketing for a draft realty
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Attaches a new land register entry to the realty
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
land_register_entry_number | string non-empty Einlagezahl (EZ) Country must be Austria. |
cadastral_municipality_id required | string non-empty Katastralgemeinde Nummer (KG-NR) Country must be Austria. |
plot_numbers | Array of strings non-empty [ items non-empty ] Grundstücksnummern (GST-NRn) Country must be Austria. |
owner_sequence_numbers | Array of integers Laufende Nummern im Eigentumsblatt (B-Blatt) Country must be Austria. |
{- "land_register_entry_number": "600",
- "cadastral_municipality_id": "01010",
- "plot_numbers": [
- "274"
], - "owner_sequence_numbers": [
- 3
]
}
{- "id": 939482
}
Deletes a land register entry attached to a realty
realtyId required | integer <int64> >= 1 The id of the realty |
realtyLandRegisterEntryId required | integer <int64> >= 1 The id of the land register entry |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Attaches a new link to the realty
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
url required | string <url> non-empty |
description required | string |
type required | string Enum: "link" "video" "tour" "project" |
object |
{- "description": "Online 3D Rundgang",
- "type": "tour",
- "export": {
- "offer": true,
- "platform": true,
- "website": true,
- "other": true
}
}
{- "id": 939482
}
Deletes a link attached to a realty
realtyId required | integer <int64> >= 1 The id of the realty |
realtyLinkId required | integer <int64> >= 1 The id of the realty link |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Retrieve realty information in format OpenImmo 1.2.7 AT2
realtyId required | integer <int64> >= 1 The id of the realty |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
<?xml version="1.0" encoding="UTF-8"?> <openimmo> ... </openimmo> </xml>
Retrieve the distance of to the nearest point of interest grouped by groups
realtyId required | integer <int64> >= 1 The id of the realty |
locale | string = 2 characters Example: locale=de |
precise | integer Default: 0 Enum: 1 0 Wether to return the precise distances or the distances depending on the public visible address |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "groups": [
- {
- "id": "health",
- "name": "Gesundheit",
- "categories": [
- {
- "id": "doctors",
- "name": "Arzt",
- "distance": 500
}
]
}
]
}
Attaches a contact to a realty as a vendor
realtyId required | integer <int64> >= 1 The id of the realty |
vendorId required | integer <int64> >= 1 The id of the vendor |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Detaches a vendor from a realty
realtyId required | integer <int64> >= 1 The id of the realty |
vendorId required | integer <int64> >= 1 The id of the vendor |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
"Ausstattungsmerkmale"
Retrieve available realty features
locale | string = 2 characters Example: locale=de |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "items": [
- {
- "group_label": "Boden",
- "items": [
- {
- "id": 1,
- "label": "Dielen"
}, - {
- "id": 2,
- "label": "Doppelboden"
}, - {
- "id": 1234,
- "label": "Spezialstahl",
- "tenant_id": 123
}
]
}, - {
- "group_label": "Befeuerung",
- "items": [
- {
- "id": 11,
- "label": "Elektro"
}, - {
- "id": 12,
- "label": "Erdwärme"
}, - {
- "id": 5678,
- "label": "Nuklear",
- "tenant_id": 123
}
]
}
]
}
{- "id": 5756,
- "prefix": "Dr.",
- "first_name": "Justine",
- "last_name": "Immo",
- "gender": "female",
- "date_of_birth": "1971-03-27",
- "suffix": "MBA",
- "email": "support@justimmo.at",
- "phone": "0123 4567890",
- "phone_mobile": "0123 4567890",
- "phone_business": "0123 4567890",
- "phone_fax": "0123 4567890",
- "profile_picture": {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg",
- "filename": "file.jpg",
- "title": "Example File Description"
}, - "position": "string",
- "immobiliencard_id": "AT01234567",
- "immobiliencard_uid": "string",
- "foreign_id": 1234,
- "role": "employee",
- "permissions": {
- "realty_module_enabled": true,
- "realty_create": true,
- "realty_view": "own",
- "realty_view_vendors": "own",
- "realty_view_internal_files": "own",
- "realty_edit": "own",
- "realty_delete": "own",
- "realty_export": "own",
- "contact_module_enabled": true,
- "contact_create": true,
- "contact_view": "own",
- "contact_edit": "own",
- "contact_delete": "own"
}, - "tenant": {
- "id": 123,
- "name": "Justimmo",
- "email": "support@justimmo.at",
- "phone": "+43 1 2345678",
- "address": {
- "street": "Mariahilferstraße 8/11",
- "zip": "1070",
- "city": "Wien",
- "country": "AT"
}
}
}
Retrieve user list
If different filter parameters are provided, those are related by AND
.
If more than one value is provided for any given filter, they are treated with an OR
relation.
fields required | string Example: fields=* Comma-separated list of fields to query for each item or |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
offset | integer >= 0 Default: 0 Skip the first |
object Example: filters[foreign_id]=123,124 |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "id": 5756,
- "prefix": "Dr.",
- "first_name": "Justine",
- "last_name": "Immo",
- "gender": "female",
- "date_of_birth": "1971-03-27",
- "suffix": "MBA",
- "email": "support@justimmo.at",
- "phone": "0123 4567890",
- "phone_mobile": "0123 4567890",
- "phone_business": "0123 4567890",
- "phone_fax": "0123 4567890",
- "profile_picture": {
- "storage_key": "4yJnjOyivaIvIjxZrG0Bnd.jpg",
- "filename": "file.jpg",
- "title": "Example File Description"
}, - "position": "string",
- "immobiliencard_id": "AT01234567",
- "immobiliencard_uid": "string",
- "foreign_id": 1234,
- "role": "employee",
- "tenant_id": 1234
}
]
}
Webhooks will be called with HTTP method POST in a FIFO order. On network errors they will be retried; if the server answers with an error (eg. 4xx/5xx) they will NOT be retried. It is up to the endpoint to implement outage recoveries.
The payload is signed with HMAC using sha256. The secret is unique per webhook and will be provided when creating a webhook in Justimmo admin UI.
The signature is provided in the X-Justimmo-Signature
header.
Called if one of the activity events registered to a specific webhook is fired
X-Justimmo-Webhook-Id required | string <uuid> Example: a06e68e7-22f1-11ed-bc0a-b8cb29967e61 The id of the webhook |
X-Justimmo-Delivery-Id required | string <uuid> Example: 880658fa-f7f0-41ac-89fa-80259d3ee183 The id of the webhook delivery |
X-Justimmo-Signature required | string Example: 5cc92460676f037c053381108a4e0cc3bec70ef60036605ba8c131585fca52b7 HMAC signature of the payload |
event required | string Enum: "activity:create" "activity:update" "activity:delete" The name of the event |
time required | string <Y-m-dTH:i:s.uO> The time the event which triggered the webhook originally happened |
required | object |
[- {
- "event": "activity:create",
- "time": "2022-08-12T14:05:30.190758+0200",
- "data": {
- "activity_id": 1234,
- "activity_type_id": 1234,
- "contact_id": 1234,
- "realty_id": 1234,
- "tenant_id": 939482
}
}
]
Called if one of the contact events registered to a specific webhook is fired
X-Justimmo-Webhook-Id required | string <uuid> Example: a06e68e7-22f1-11ed-bc0a-b8cb29967e61 The id of the webhook |
X-Justimmo-Delivery-Id required | string <uuid> Example: 880658fa-f7f0-41ac-89fa-80259d3ee183 The id of the webhook delivery |
X-Justimmo-Signature required | string Example: 5cc92460676f037c053381108a4e0cc3bec70ef60036605ba8c131585fca52b7 HMAC signature of the payload |
event required | string Enum: "contact:create" "contact:update" "contact:delete" The name of the event |
time required | string <Y-m-dTH:i:s.uO> The time the event which triggered the webhook originally happened |
required | object |
[- {
- "event": "contact:create",
- "time": "2022-08-12T14:05:30.190758+0200",
- "data": {
- "contact_id": 1234,
- "tenant_id": 939482
}
}
]
Called if one of the hit events registered to a specific webhook is fired
X-Justimmo-Webhook-Id required | string <uuid> Example: a06e68e7-22f1-11ed-bc0a-b8cb29967e61 The id of the webhook |
X-Justimmo-Delivery-Id required | string <uuid> Example: 880658fa-f7f0-41ac-89fa-80259d3ee183 The id of the webhook delivery |
X-Justimmo-Signature required | string Example: 5cc92460676f037c053381108a4e0cc3bec70ef60036605ba8c131585fca52b7 HMAC signature of the payload |
event required | string Enum: "hit:create:match" "hit:delete:unmatch" "hit:delete:offer" "hit:delete:inapt" The name of the event |
time required | string <Y-m-dTH:i:s.uO> The time the event which triggered the webhook originally happened |
required | object |
[- {
- "event": "hit:create:match",
- "time": "2022-08-12T14:05:30.190758+0200",
- "data": {
- "realty_id": 1234,
- "contact_id": 939482,
- "tenant_id": 939482
}
}
]
Called after a openimmo xml uploaded to an ftp server has been imported
X-Justimmo-Webhook-Id required | string <uuid> Example: a06e68e7-22f1-11ed-bc0a-b8cb29967e61 The id of the webhook |
X-Justimmo-Delivery-Id required | string <uuid> Example: 880658fa-f7f0-41ac-89fa-80259d3ee183 The id of the webhook delivery |
X-Justimmo-Signature required | string Example: 5cc92460676f037c053381108a4e0cc3bec70ef60036605ba8c131585fca52b7 HMAC signature of the payload |
event required | string Enum: "import:realty:success" "import:realty:fail" The name of the event |
time required | string <Y-m-dTH:i:s.uO> The time the event which triggered the webhook originally happened |
required | object |
[- {
- "event": "import:realty:success",
- "time": "2022-08-12T14:05:30.190758+0200",
- "data": {
- "feed_id": 1234,
- "tenant_id": 939482,
- "file": "upload-test-3.xml",
- "succeeded": 15,
- "failed": 2
}
}
]
Called if one of the inquiry events registered to a specific webhook is fired
X-Justimmo-Webhook-Id required | string <uuid> Example: a06e68e7-22f1-11ed-bc0a-b8cb29967e61 The id of the webhook |
X-Justimmo-Delivery-Id required | string <uuid> Example: 880658fa-f7f0-41ac-89fa-80259d3ee183 The id of the webhook delivery |
X-Justimmo-Signature required | string Example: 5cc92460676f037c053381108a4e0cc3bec70ef60036605ba8c131585fca52b7 HMAC signature of the payload |
event required | string Value: "inquiry:create" The name of the event |
time required | string <Y-m-dTH:i:s.uO> The time the event which triggered the webhook originally happened |
required | object |
[- {
- "event": "inquiry:create",
- "time": "2022-08-12T14:05:30.190758+0200",
- "data": {
- "inquiry_id": 1234,
- "contact_id": 1234,
- "realty_id": 1234,
- "tenant_id": 939482
}
}
]
Called if one of the realty events registered to a specific webhook is fired
X-Justimmo-Webhook-Id required | string <uuid> Example: a06e68e7-22f1-11ed-bc0a-b8cb29967e61 The id of the webhook |
X-Justimmo-Delivery-Id required | string <uuid> Example: 880658fa-f7f0-41ac-89fa-80259d3ee183 The id of the webhook delivery |
X-Justimmo-Signature required | string Example: 5cc92460676f037c053381108a4e0cc3bec70ef60036605ba8c131585fca52b7 HMAC signature of the payload |
event required | string Enum: "realty:create" "realty:update" "realty:delete" "realty:state:update" "realty:vendor:update" The name of the event |
time required | string <Y-m-dTH:i:s.uO> The time the event which triggered the webhook originally happened |
required | object |
[- {
- "event": "realty:create",
- "time": "2022-08-12T14:05:30.190758+0200",
- "data": {
- "realty_id": 1234,
- "tenant_id": 939482
}
}
]
Called if one of the search profile events registered to a specific webhook is fired
X-Justimmo-Webhook-Id required | string <uuid> Example: a06e68e7-22f1-11ed-bc0a-b8cb29967e61 The id of the webhook |
X-Justimmo-Delivery-Id required | string <uuid> Example: 880658fa-f7f0-41ac-89fa-80259d3ee183 The id of the webhook delivery |
X-Justimmo-Signature required | string Example: 5cc92460676f037c053381108a4e0cc3bec70ef60036605ba8c131585fca52b7 HMAC signature of the payload |
event required | string Enum: "search-profile:create" "search-profile:update" "search-profile:delete" The name of the event |
time required | string <Y-m-dTH:i:s.uO> The time the event which triggered the webhook originally happened |
required | object |
[- {
- "event": "search-profile:create",
- "time": "2022-08-12T14:05:30.190758+0200",
- "data": {
- "search_profile_id": 1234,
- "tenant_id": 939482
}
}
]
Retrieve an list of all registered webhooks for this client and tenant
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{- "items": [
- {
- "id": "0194db4c-601c-7ef5-ba4a-d7164219a769",
- "client_id": "example_client",
- "tenant_id": 5,
- "created_by_client": true,
- "events": [
- "contact:create",
- "contact:update",
- "contact:delete"
]
}
]
}
Create a new webhook
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
endpoint required | string <url> |
events required | Array of strings Please contact us to inquire what |
{- "events": [
- "contact:create",
- "contact:update",
- "contact:delete"
]
}
{- "id": "0194dbe2-85b8-7598-9e40-62092ca9d86b",
- "secret": "string"
}
Retrieve a list of all deliveries of a webhook. Only deliveries of the last 15 days are available
webhookId required | string <uuid> The id of the webhook |
limit | integer [ 1 .. 100 ] Default: 10 Max count of items returned at once |
offset | integer >= 0 Default: 0 Skip the first |
object Filters the results | |
sort | string Default: "created_at_DESC" Enum: "created_at_ASC" "created_at_DESC" "executed_at_ASC" "executed_at_DESC" Sorts the results |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
{- "pagination": {
- "limit": 10,
- "offset": 0,
- "total": 445
}, - "items": [
- {
- "delivery_id": "880658fa-f7f0-41ac-89fa-80259d3ee183",
- "state": "delivered",
- "executed_at": "2022-08-12T14:05:30.190758+0200",
- "status_code": 200,
- "event": "contact:create",
- "time": "2022-08-12T14:05:30.190758+0200",
- "data": {
- "contact_id": 1234,
- "tenant_id": 939482
}
}
]
}
Deletes a webhook and all the deliveries for this webhook - sent as well as unset ones.
webhookId required | string <uuid> The id of the webhook |
X-Justimmo-TenantId required | integer Example: 1372 This is necessary to determine which tenant's data to operate on. |
X-Justimmo-UserId | integer Example: 22021910 This is necessary to allow your client to act on behalf of a specific user, adhering to the user's permissions. required for authorization method |
{ }
Deprecated
Value | Naheverhältnis |
---|---|
family |
familiär |
family_double_agent |
familiär mit Doppelmaklertätigkeit |
economic |
wirtschaftlich |
economic_double_agent |
wirtschaftlich mit Doppelmaklertätigkeit |
Value | Type of Area | Value Object |
---|---|---|
site_area |
"Grundfläche" | RealtyArea |
living_area |
"Wohnfläche" | RealtyArea |
floor_area |
"Nutzfläche" | RealtyArea |
developable_area |
"Verbaubare Fläche" | RealtyArea |
office_area |
"Bürofläche" | RealtyArea |
sales_area |
"Verkaufsfläche" | RealtyArea |
storage_area |
"Lagerfläche" | RealtyArea |
available_area |
"Freie Fläche" | RealtyArea |
short_term_area |
"Befristete Fläche" | RealtyArea |
total_area |
"Gesamtfläche" | RealtyArea |
weighted_area |
"Gewichtete Fläche" | RealtyArea |
undeveloped_attic_area |
"Rohdachbodenfläche" | RealtyArea |
garden_area |
"Gartenfläche" | RealtyCountableArea |
basement_area |
"Kellerfläche" | RealtyCountableArea |
balcony_area |
"Balkonfläche" | RealtyCountableArea |
terrace_area |
"Terrassenfläche" | RealtyCountableArea |
covered_balcony_area |
"Loggiafläche" | RealtyCountableArea |
garage_area |
"Garagenfläche" | RealtyCountableArea |
parking_space_area |
"Stellplatzfläche" | RealtyCountableArea |
Value | Description | Value Type |
---|---|---|
rooms |
"Anzahl Zimmer" | float |
toilets |
"Anzahl WC" | int |
bathrooms |
"Anzahl Bäder" | int |
storerooms |
"Anzahl Abstellräume" | int |
Value | Type of Price | Value Object |
---|---|---|
purchase_price |
"Kaufpreis" | RealtyPrice |
rent |
"Miete" | RealtyPrice |
furniture_hire |
"Möbelmiete" | RealtyPrice |
parking |
"Parkplatz" | RealtyPrice |
garage |
"Garage" | RealtyPrice |
operating |
"Betriebskosten" | RealtyPrice |
heating |
"Heizkosten" | RealtyPrice |
hot_water |
"Warmwasser" | RealtyPrice |
cooling |
"Kühlung" | RealtyPrice |
maintenance_funds |
"Reparaturrücklage" | RealtyPrice |
elevator |
"Liftkosten" | RealtyPrice |
others |
"Sonstiges" | RealtyPrice |
purchase_price
and rent
are only included in response when applicable based on marketing_type
.
ID | Name |
---|---|
4 | "Entwurf" |
5 | "aktiv" |
6 | "inaktiv (Deprecated)" |
7 | "reserviert" |
8 | "vermittelt" |
9 | "storniert" |
10 | "fremdvermittelt" |
11 | "Vertragserrichtung" |
Value | Objekttyp |
---|---|
realty |
"Eigenständiges Objekt" |
residential_project |
"Wohnbauprojekt" |
residential_subunit |
"Wohnbauprojekt Untereinheit" |
commercial_project |
"Gewerbeprojekt" |
commercial_area |
"Gewerbeprojekt Fläche" |
Value Object: RealtyType
List of all available main realty types (Objektarten) of Justimmo. If "OpenImmo Key" is empty, the Main Type is not part of the OpenImmo standard.
ID | Name | OpenImmo Key |
---|---|---|
1 | Zimmer | zimmer |
2 | Wohnung | wohnung |
3 | Haus | haus |
4 | Grundstück | grundstueck |
5 | Büro / Praxis | buero_praxen |
6 | Einzelhandel | einzelhandel |
7 | Gastgewerbe | gastgewerbe |
8 | Industrie / Gewerbe | hallen_lager_prod |
9 | Land und Forstwirtschaft | land_und_forstwirtschaft |
10 | Sonstige / Sonderobjekte | sonstige |
11 | Freizeitimmobilie gewerblich | freizeitimmobilie_gewerblich |
12 | Zinshaus / Renditeobjekt | zinshaus_renditeobjekt |
13 | Parken | parken |
Value Object: RealtySubType
List of all available sub realty types (Unterobjektarten) of Justimmo. If "OpenImmo Key" is empty, the Sub Type is not part of the OpenImmo standard.
ID | Name | OpenImmo Key |
---|---|---|
1 | Baugrund Eigenheim | WOHNEN |
2 | Großvolumiger Wohnbau | |
3 | Wohn- und Geschäftsbaugrund | |
4 | Betriebsbaugrund | GEWERBE |
5 | Seegrund | SEELIEGENSCHAFT |
6 | Sonstiger Grund | |
7 | Industriebaugrund | INDUSTRIE |
8 | Einfamilienhaus | EINFAMILIENHAUS |
9 | Mehrfamilienhaus | MEHRFAMILIENHAUS |
10 | Reihenhaus | REIHENHAUS |
11 | Bauernhaus | BAUERNHAUS |
12 | Laube-Datsche-Gartenhaus | LAUBE-DATSCHE-GARTENHAUS |
13 | Sonstiges Haus | |
14 | Rohbau | |
15 | Reihenendhaus | REIHENEND |
16 | Reihenmittelhaus | REIHENMITTEL |
17 | Reiheneckhaus | REIHENECK |
18 | Doppelhaushälfte | DOPPELHAUSHAELFTE |
19 | Bungalow | BUNGALOW |
20 | Villa | VILLA |
21 | Strandhaus | STRANDHAUS |
22 | Landhaus | LANDHAUS |
23 | Terrassenhaus | |
24 | Sacherl | |
25 | Büro | |
26 | Bürohaus | BUEROHAUS |
27 | Sonstiges Büro | |
28 | Praxis | PRAXIS |
29 | Ausstellungsfläche | AUSSTELLUNGSFLAECHE |
30 | Gastronomie/Restaurant | GASTRONOMIE |
31 | Imbiss | |
32 | Café | CAFE |
33 | Veranstaltungsobjekt | |
34 | Landwirtschaftliche Betriebe | LANDWIRTSCHAFTLICHE_BETRIEBE |
35 | Bauernhof | BAUERNHOF |
36 | Gartenbau | GARTENBAU |
37 | Ackerbau | ACKERBAU |
38 | Weinbau | WEINBAU |
39 | Viehwirtschaft | VIEHWIRTSCHAFT |
40 | Jagd und Forstwirtschaft | JAGD_UND_FORSTWIRTSCHAFT |
41 | Jagdrevier | JAGDREVIER |
42 | Teich / Fischzucht | TEICH_UND_FISCHWIRTSCHAFT |
43 | Scheune | SCHEUNEN |
44 | Reiterhof | REITERHOEFE |
45 | Wohnung | |
46 | Genossenschaftswohnung | |
47 | Rohdachboden | ROHDACHBODEN |
49 | Penthouse | PENTHOUSE |
50 | Sonstige Wohnung | |
51 | Maisonette | MAISONETTE |
52 | Loft-Studio-Atelier | LOFT-STUDIO-ATELIER |
53 | Dachgeschoß | DACHGESCHOSS |
54 | Terrassenwohnung | TERRASSEN |
55 | Souterrain | SOUTERRAIN |
56 | Vorsorgewohnung | |
57 | Schloss | SCHLOSS |
59 | Garçonnière | |
60 | Apartment | APARTMENT |
61 | Bürofläche | BUEROFLAECHE |
62 | Ladenlokal | LADENLOKAL |
63 | Einzelhandelsladen | EINZELHANDELSLADEN |
64 | Verbrauchermarkt | VERBRAUCHERMARKT |
65 | Einkaufszentrum | EINKAUFSZENTRUM |
66 | Sportanlagen | SPORTANLAGEN |
67 | Vergnügungsparks / -center | VERGNUEGUNGSPARKS_UND_CENTER |
68 | Gastronomie und Wohnung | GASTRONOMIE_UND_WOHNUNG |
69 | Pensionen | PENSIONEN |
70 | Hotels | HOTELS |
71 | weitere Beherbergungsbetriebe | WEITERE_BEHERBERGUNGSBETRIEBE |
72 | Land- und Forstwirtschaft | LAND_FORSTWIRSCHAFT |
73 | Freizeit | FREIZEIT |
74 | Gemischt | GEMISCHT |
75 | Sondernutzung | SONDERNUTZUNG |
76 | Halle | HALLE |
77 | Lager | LAGER |
78 | Produktion / Betriebsobjekt | PRODUKTION |
79 | Werkstatt | WERKSTATT |
80 | Hochregallager | HOCHREGALLAGER |
81 | Service | SERVICE |
82 | Freiflächen | FREIFLAECHEN |
83 | Stadthaus | STADTHAUS |
84 | Resthof | RESTHOF |
85 | Zweifamilienhaus | ZWEIFAMILIENHAUS |
86 | Ferienhaus | FERIENHAUS |
87 | Berghütte | BERGHUETTE |
88 | Chalet | CHALET |
89 | Krankenhaus | KRANKENHAUS |
90 | Pflegeheim | PFLEGEHEIM |
91 | Sanatorium | SANATORIUM |
92 | Seniorenheim | SENIORENHEIM |
93 | Betreutes Wohnen | BETREUTES-WOHNEN |
95 | Aussiedlerhof | AUSSIEDLERHOF |
96 | Sonstige Landwirtschaftsimmobilien | SONSTIGE_LANDWIRTSCHAFTSIMMOBILIEN |
97 | Parkhaus | PARKHAUS |
98 | Tankstelle | TANKSTELLE |
99 | Einzelgarage | EINZELGARAGE |
100 | Stellplatz | STELLPLATZ |
101 | Sonstige | SONSTIGE |
102 | Etagenwohnung | ETAGE |
103 | Erdgeschoß | ERDGESCHOSS |
104 | Mehrfamilienhaus | MEHRFAMILIENHAUS |
105 | Wohn- und Geschäftshaus | WOHN_UND_GESCHAEFTSHAUS |
106 | Geschäftshaus | GESCHAEFTSHAUS |
107 | Bürogebäude | BUEROGEBAEUDE |
108 | Selbstbedienungsmärkte | SB_MAERKTE |
109 | Einkaufszentren | EINKAUFSCENTREN |
110 | Wohnanlagen | WOHNANLAGEN |
111 | Verbrauchermärkte | VERBRAUCHERMAERKTE |
112 | Industrieanlagen | INDUSTRIEANLAGEN |
113 | Geschäftslokal | |
114 | Renditeobjekt | |
115 | Verwertungsobjekt | |
116 | Entwicklungsobjekt | |
117 | Gartenwohnung | |
118 | Apartmenthaus | APARTMENTHAUS |
119 | Ferienwohnung | FERIENWOHNUNG |
120 | Galeriewohnung | GALERIE |
121 | Seeliegenschaft | SEELIEGENSCHAFT |
122 | Seeliegenschaft | |
123 | Anwesen | ANWESEN |
124 | Speditionslager | SPEDITIONSLAGER |
125 | Bootsliegeplatz | BOOTSLIEGEPLATZ |
126 | Burg | BURG |
127 | Herrenhaus | HERRENHAUS |
128 | Finca | FINCA |
129 | Fertighaus | FERTIGHAUS |
130 | Gewerbepark | GEWERBEPARK |
131 | Bürozentrum | BUEROZENTRUM |
132 | Loft / Atelier | LOFT_ATELIER |
133 | Praxisfläche | PRAXISFLAECHE |
134 | Praxishaus | PRAXISHAUS |
135 | Coworking Space | COWORKING |
136 | Shared Office | SHARED_OFFICE |
137 | Kaufhaus | KAUFHAUS |
138 | Factory outlet | FACTORY_OUTLET |
141 | Kiosk | KIOSK |
142 | Verkaufsfläche | VERKAUFSFLAECHE |
143 | Ausstellungsfläche | AUSSTELLUNGSFLAECHE |
144 | Bar | BAR |
145 | Discothek | DISCOTHEK |
146 | Industriehalle | INDUSTRIEHALLE |
147 | Lagerflächen | LAGERFLAECHEN |
148 | Lager mit Freifläche | LAGER_MIT_FREIFLAECHE |
149 | Kühlhaus | KUEHLHAUS |
150 | Freizeitanlage | FREIZEITANLAGE |
152 | Carport | CARPORT |
153 | Doppelgarage | DOPPELGARAGE |
154 | Duplex | DUPLEX |
155 | Tiefgarage | TIEFGARAGE |
156 | Parkhaus | PARKHAUS |
157 | Tiefgaragenstellplatz | TIEFGARAGENSTELLPLATZ |
158 | Parkplatz mit Ladestation | PARKPLATZ_STROM |
Lists of all Sub Types grouped by their corresponding Main Type.
ID | Name | OpenImmo Key |
---|---|---|
45 | Wohnung | |
46 | Genossenschaftswohnung | |
47 | Rohdachboden | ROHDACHBODEN |
49 | Penthouse | PENTHOUSE |
50 | Sonstige Wohnung | |
51 | Maisonette | MAISONETTE |
52 | Loft-Studio-Atelier | LOFT-STUDIO-ATELIER |
53 | Dachgeschoß | DACHGESCHOSS |
54 | Terrassenwohnung | TERRASSEN |
55 | Souterrain | SOUTERRAIN |
56 | Vorsorgewohnung | |
59 | Garçonnière | |
60 | Apartment | APARTMENT |
102 | Etagenwohnung | ETAGE |
103 | Erdgeschoß | ERDGESCHOSS |
117 | Gartenwohnung | |
119 | Ferienwohnung | FERIENWOHNUNG |
120 | Galeriewohnung | GALERIE |
ID | Name | OpenImmo Key |
---|---|---|
8 | Einfamilienhaus | EINFAMILIENHAUS |
9 | Mehrfamilienhaus | MEHRFAMILIENHAUS |
10 | Reihenhaus | REIHENHAUS |
11 | Bauernhaus | BAUERNHAUS |
12 | Laube-Datsche-Gartenhaus | LAUBE-DATSCHE-GARTENHAUS |
13 | Sonstiges Haus | |
14 | Rohbau | |
15 | Reihenendhaus | REIHENEND |
16 | Reihenmittelhaus | REIHENMITTEL |
17 | Reiheneckhaus | REIHENECK |
18 | Doppelhaushälfte | DOPPELHAUSHAELFTE |
19 | Bungalow | BUNGALOW |
20 | Villa | VILLA |
21 | Strandhaus | STRANDHAUS |
22 | Landhaus | LANDHAUS |
23 | Terrassenhaus | |
24 | Sacherl | |
57 | Schloss | SCHLOSS |
83 | Stadthaus | STADTHAUS |
84 | Resthof | RESTHOF |
85 | Zweifamilienhaus | ZWEIFAMILIENHAUS |
86 | Ferienhaus | FERIENHAUS |
87 | Berghütte | BERGHUETTE |
88 | Chalet | CHALET |
118 | Apartmenthaus | APARTMENTHAUS |
122 | Seeliegenschaft | |
126 | Burg | BURG |
127 | Herrenhaus | HERRENHAUS |
128 | Finca | FINCA |
129 | Fertighaus | FERTIGHAUS |
ID | Name | OpenImmo Key |
---|---|---|
1 | Baugrund Eigenheim | WOHNEN |
2 | Großvolumiger Wohnbau | |
3 | Wohn- und Geschäftsbaugrund | |
4 | Betriebsbaugrund | GEWERBE |
5 | Seegrund | SEELIEGENSCHAFT |
6 | Sonstiger Grund | |
7 | Industriebaugrund | INDUSTRIE |
72 | Land- und Forstwirtschaft | LAND_FORSTWIRSCHAFT |
73 | Freizeit | FREIZEIT |
74 | Gemischt | GEMISCHT |
75 | Sondernutzung | SONDERNUTZUNG |
121 | Seeliegenschaft | SEELIEGENSCHAFT |
130 | Gewerbepark | GEWERBEPARK |
ID | Name | OpenImmo Key |
---|---|---|
25 | Büro | |
26 | Bürohaus | BUEROHAUS |
27 | Sonstiges Büro | |
28 | Praxis | PRAXIS |
29 | Ausstellungsfläche | AUSSTELLUNGSFLAECHE |
61 | Bürofläche | BUEROFLAECHE |
131 | Bürozentrum | BUEROZENTRUM |
132 | Loft / Atelier | LOFT_ATELIER |
133 | Praxisfläche | PRAXISFLAECHE |
134 | Praxishaus | PRAXISHAUS |
135 | Coworking Space | COWORKING |
136 | Shared Office | SHARED_OFFICE |
ID | Name | OpenImmo Key |
---|---|---|
62 | Ladenlokal | LADENLOKAL |
63 | Einzelhandelsladen | EINZELHANDELSLADEN |
64 | Verbrauchermarkt | VERBRAUCHERMARKT |
65 | Einkaufszentrum | EINKAUFSZENTRUM |
113 | Geschäftslokal | |
137 | Kaufhaus | KAUFHAUS |
138 | Factory outlet | FACTORY_OUTLET |
141 | Kiosk | KIOSK |
142 | Verkaufsfläche | VERKAUFSFLAECHE |
143 | Ausstellungsfläche | AUSSTELLUNGSFLAECHE |
ID | Name | OpenImmo Key |
---|---|---|
30 | Gastronomie/Restaurant | GASTRONOMIE |
31 | Imbiss | |
32 | Café | CAFE |
33 | Veranstaltungsobjekt | |
68 | Gastronomie und Wohnung | GASTRONOMIE_UND_WOHNUNG |
69 | Pensionen | PENSIONEN |
70 | Hotels | HOTELS |
71 | weitere Beherbergungsbetriebe | WEITERE_BEHERBERGUNGSBETRIEBE |
144 | Bar | BAR |
145 | Discothek | DISCOTHEK |
ID | Name | OpenImmo Key |
---|---|---|
76 | Halle | HALLE |
77 | Lager | LAGER |
78 | Produktion / Betriebsobjekt | PRODUKTION |
79 | Werkstatt | WERKSTATT |
80 | Hochregallager | HOCHREGALLAGER |
81 | Service | SERVICE |
82 | Freiflächen | FREIFLAECHEN |
124 | Speditionslager | SPEDITIONSLAGER |
146 | Industriehalle | INDUSTRIEHALLE |
147 | Lagerflächen | LAGERFLAECHEN |
148 | Lager mit Freifläche | LAGER_MIT_FREIFLAECHE |
149 | Kühlhaus | KUEHLHAUS |
ID | Name | OpenImmo Key |
---|---|---|
34 | Landwirtschaftliche Betriebe | LANDWIRTSCHAFTLICHE_BETRIEBE |
35 | Bauernhof | BAUERNHOF |
36 | Gartenbau | GARTENBAU |
37 | Ackerbau | ACKERBAU |
38 | Weinbau | WEINBAU |
39 | Viehwirtschaft | VIEHWIRTSCHAFT |
40 | Jagd und Forstwirtschaft | JAGD_UND_FORSTWIRTSCHAFT |
41 | Jagdrevier | JAGDREVIER |
42 | Teich / Fischzucht | TEICH_UND_FISCHWIRTSCHAFT |
43 | Scheune | SCHEUNEN |
44 | Reiterhof | REITERHOEFE |
95 | Aussiedlerhof | AUSSIEDLERHOF |
96 | Sonstige Landwirtschaftsimmobilien | SONSTIGE_LANDWIRTSCHAFTSIMMOBILIEN |
123 | Anwesen | ANWESEN |
ID | Name | OpenImmo Key |
---|---|---|
89 | Krankenhaus | KRANKENHAUS |
97 | Parkhaus | PARKHAUS |
98 | Tankstelle | TANKSTELLE |
101 | Sonstige | SONSTIGE |
ID | Name | OpenImmo Key |
---|---|---|
66 | Sportanlagen | SPORTANLAGEN |
67 | Vergnügungsparks / -center | VERGNUEGUNGSPARKS_UND_CENTER |
150 | Freizeitanlage | FREIZEITANLAGE |
ID | Name | OpenImmo Key |
---|---|---|
90 | Pflegeheim | PFLEGEHEIM |
91 | Sanatorium | SANATORIUM |
92 | Seniorenheim | SENIORENHEIM |
93 | Betreutes Wohnen | BETREUTES-WOHNEN |
104 | Mehrfamilienhaus | MEHRFAMILIENHAUS |
105 | Wohn- und Geschäftshaus | WOHN_UND_GESCHAEFTSHAUS |
106 | Geschäftshaus | GESCHAEFTSHAUS |
107 | Bürogebäude | BUEROGEBAEUDE |
108 | Selbstbedienungsmärkte | SB_MAERKTE |
109 | Einkaufszentren | EINKAUFSCENTREN |
110 | Wohnanlagen | WOHNANLAGEN |
111 | Verbrauchermärkte | VERBRAUCHERMAERKTE |
112 | Industrieanlagen | INDUSTRIEANLAGEN |
114 | Renditeobjekt | |
115 | Verwertungsobjekt | |
116 | Entwicklungsobjekt |
ID | Name | OpenImmo Key |
---|---|---|
99 | Einzelgarage | EINZELGARAGE |
100 | Stellplatz | STELLPLATZ |
125 | Bootsliegeplatz | BOOTSLIEGEPLATZ |
152 | Carport | CARPORT |
153 | Doppelgarage | DOPPELGARAGE |
154 | Duplex | DUPLEX |
155 | Tiefgarage | TIEFGARAGE |
156 | Parkhaus | PARKHAUS |
157 | Tiefgaragenstellplatz | TIEFGARAGENSTELLPLATZ |
158 | Parkplatz mit Ladestation | PARKPLATZ_STROM |
ID | Zustand | OpenImmo Key |
---|---|---|
1 | Erstbezug | ERSTBEZUG |
2 | renovierungsbedürftig | TEIL_VOLLRENOVIERUNGSBED |
3 | neuwertig | NEUWERTIG |
4 | vollsaniert | VOLL_SANIERT |
5 | vollrenoviert | TEIL_VOLLRENOVIERT |
6 | baufällig | BAUFAELLIG |
7 | nach Vereinbarung | NACH_VEREINBARUNG |
8 | modernisiert | MODERNISIERT |
9 | gepflegt | GEPFLEGT |
10 | Rohbau | ROHBAU |
11 | entkernt | ENTKERNT |
12 | Abrissobjekt | ABRISSOBJEKT |
13 | projektiert | PROJEKTIERT |
14 | teilsaniert | TEIL_SANIERT |
15 | teilrenoviert | TEIL_VOLLRENOVIERT |
16 | sanierungsbedürftig | SANIERUNGSBEDUERFTIG |
ID | Zustand | OpenImmo Key |
---|---|---|
1 | Erstbezug | ERSTBEZUG |
2 | renovierungsbedürftig | TEIL_VOLLRENOVIERUNGSBED |
3 | neuwertig | NEUWERTIG |
4 | vollsaniert | VOLL_SANIERT |
5 | vollrenoviert | TEIL_VOLLRENOVIERT |
6 | baufällig | BAUFAELLIG |
7 | nach Vereinbarung | NACH_VEREINBARUNG |
8 | modernisiert | MODERNISIERT |
9 | gepflegt | GEPFLEGT |
10 | Rohbau | ROHBAU |
11 | entkernt | ENTKERNT |
12 | Abrissobjekt | ABRISSOBJEKT |
13 | projektiert | PROJEKTIERT |
14 | teilsaniert | TEIL_SANIERT |
15 | teilrenoviert | TEIL_VOLLRENOVIERT |
ID | Möblierung | OpenImmo Key |
---|---|---|
1 | möbliert | VOLL |
2 | teilmöbliert | TEIL |
3 | nicht möbliert | |
4 | optional | |
7 | Küche | |
8 | Küche, Bad | |
9 | Kochnische | |
10 | Geschäftseinrichtung | |
11 | Bad |
Value | Description |
---|---|
sole_agency_agreement | Alleinvermittlungsauftrag |
co_sole_agency_agreement | Co-Alleinvermittlungsauftrag |
simple_agency_agreement | schlichter Vermittlungsauftrag |
Value | Description |
---|---|
verbal | mündlich |
written | schriftlich |
written_bilateral | schriftlich (beidseitig) |
ID | Name |
---|---|
1 | Public / Pictures |
2 | Public / Plans |
3 | Public / Video |
4 | Public / Documents |
7 | Public / 360 |
8 | Public / Expose Pictures |
9 | Public / Expose Plans |
26 | Shared / Pictures |
27 | Shared / Documents |
6 | Internal / Pictures |
5 | Internal / Documents |
ID | Name |
---|---|
1 | Alleineigentum |
2 | Miteigentum |
3 | Miteigentum m. Benutzungsregelung |
4 | Wohnungseigentum |
5 | Wohnungseigentum geplant |
6 | Wohnungseigentum in Entstehung |
7 | Baurecht |
8 | Superädifikat |
9 | Schlichtes Miteigentum |
10 | Schlichtes Miteigentum m. Benutzungsregelung |
ID | Name |
---|---|
1 | absolute Ruhelage |
2 | geringe Beeinträchtigung |
3 | durchschnittliche Beeinträchtigung |
4 | Beeinträchtigung gegeben |
5 | Ruhelage |
Value | Naheverhältnis |
---|---|
none |
Kein Naheverhältnis |
family_or_economic |
Familiäres oder wirtschaftliches Naheverhältnis |
economic_interconnection |
Wirtschaftliches Naheverhältnis mit gesellschaftlicher Verflechtung |
Valid values depend on the realty marketing_type
Value | Name | Buy | Rent | |
---|---|---|---|---|
percentage_text | % des Kaufpreises (Text) | x | ||
percentage_value | % des Kaufpreises (Wert) | x | ||
monthly_rent_text | x Monatsmieten (Text) | x | ||
monthly_rent_value | x Monatsmieten (Wert) | x | ||
value | Wert | x | x | |
free | Provision bezahlt der Abgeber | x | x | |
principle_of_first_instruction | Erstauftraggeberprinzip | x | may not be set directly |