Justimmo
API docs by Redocly

Justimmo BusinessAPI (1.85.0)

Download OpenAPI specification:

E-mail: support@justimmo.at

OpenAPI Specification

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.

API URL

Unless stated otherwise, the API endpoint is located at https://api.justimmo.at/v1.

Cross-Origin Resource Sharing

This API does NOT feature any Cross-Origin Resource Sharing (CORS) / CORS-Headers as it is meant for server-side consumption only.

Authentication

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.

auth_token

User Credential Grant

Header: X-Justimmo-TenantId: <id>
This is necessary to determine which tenant's data to operate on.

Security Scheme Type: OAuth2
Flow type: authorizationCode
Authorization URL: https://auth.justimmo.at/authorize
Token URL: https://auth.justimmo.at/access_token

client_credentials

Client Credential Grant

Header: X-Justimmo-TenantId: <id>
This is necessary to determine which tenant's data to operate on.

Security Scheme Type: OAuth2
Flow type: clientCredentials
Token URL: https://auth.justimmo.at/access_token

client_credentials_impersonation

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.

Security Scheme Type: OAuth2
Flow type: clientCredentials
Token URL: https://auth.justimmo.at/access_token

Scopes

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.

Rate Limiting

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.

Activity

Create activities for realties or contacts or retrieve realty activities

Create Activity

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.

Authorizations:
auth_tokenclient_credentials_impersonation
header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
activity_type_id
required
integer

The numerical representation of the type of activity (ie "Contact has been updated", "Realty has changed status", etc...).
Please contact us to inquire what activity_type_id to use for your specific use case.

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 created_at is provided, the current time will be assumed for it.

Responses

Request samples

Content type
application/json
{
  • "activity_type_id": 1020,
  • "realty_id": 0,
  • "contact_id": 0,
  • "text": "string",
  • "created_at": "2020-05-01T12:13:25+00:00"
}

Response samples

Content type
application/json
{
  • "id": 939482
}

Activity Details

Retrieve activity information

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
activityId
required
integer <int64> >= 1

The id of the activity

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "agent": {
    },
  • "contact": {
    },
  • "realty": {
    },
  • "offer": {
    },
  • "comment": "Balkon zu klein",
  • "offertext": "Sehr geehrter Herr Mustermann, [...]",
  • "files": [
    ]
}

Create Activity File

Uploads a file and attaches it to the activity

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
activityId
required
integer <int64> >= 1

The id of the activity

header Parameters
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 client_credentials_impersonation.

Request Body schema: multipart/form-data
required
file
required
string <binary>
title
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Activity File

Deletes a file attached to an activity

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
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

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

List Realty Activities

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.

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

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 offset items

object

Filters the results

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Appointment

Retrieve or manipulate appointment related information

List appointments

Retrieve a list of appointments

Authorizations:
auth_tokenclient_credentials
query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

limit
integer [ 1 .. 100 ]
Default: 10

Max count of items returned at once

offset
integer >= 0
Default: 0

Skip the first offset items

object

Example: filters[contact_id]=123,124
Filters the results

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Create Appointment

Create a new appointment

Authorizations:
auth_tokenclient_credentials_impersonation
header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
One of
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 null, the creator (header X-Justimmo-User) will be used.

contact_id
integer or null <int64>

required if invite is set and not null.

realty_id
integer or null <int64>

required if invite is set to "realty".

object or null (WriteAppointmentInvite)

The contact as specified by contact_id will receive an invite via email.
They will also receive a reminder via SMS 24 hours before the appointment takes place, if a valid phone number is on record and it's been at least 8 hours since the invite.

If this property is null or undefined, there will not be an invite / reminder. Otherwise, contact_id is required.

comment
string or null
exclude_from_report
boolean
Default: false

Responses

Request samples

Content type
application/json
Example
{
  • "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": {
    },
  • "comment": "string",
  • "exclude_from_report": false
}

Response samples

Content type
application/json
{
  • "id": 57593657
}

Update Appointment

Update an existing appointment

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
appointmentId
required
integer <int64> >= 1

The id of the appointment

header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
One of
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 contact_id will receive an invite via email.
They will also receive a reminder via SMS 24 hours before the appointment takes place, if a valid phone number is on record and it's been at least 8 hours since the invite.

If this property is null or undefined, there will not be an invite / reminder. Otherwise, contact_id is required.

comment
string or null
exclude_from_report
boolean
Default: false

Responses

Request samples

Content type
application/json
Example
{
  • "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": {
    },
  • "comment": "string",
  • "exclude_from_report": false
}

Response samples

Content type
application/json
{ }

Delete Appointment

Deletes an appointment

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
appointmentId
required
integer <int64> >= 1

The id of the appointment

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Acquisition

Retrieve or manipulate acquisition realty related information

Create Acquisition Realty

Create an new acquisition realty

Authorizations:
auth_tokenclient_credentials_impersonation
header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
required
object (CreateRealtyAddress)
land_registry_number
string
Deprecated

Einlagezahl (EZ)

Country must be Austria.

Deprecated: Use Create/Update RealtyLandRegisterEntry endpoints instead or use land_register_entry when creating a new acquisition realty.

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 land_register_entry when creating a new acquisition realty.

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 land_register_entry when creating a new acquisition realty.

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

see Lookup Tables: RealtyType

subtype_id
integer

Subobjektart Id

see Lookup Tables: RealtySubType

required
object

Nutzungsart

At least one of these must be true

marketing_type
required
string (RealtyMarketingType)
Enum: "buy" "rent"
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 (RealtyFloors)
object or null (WriteRooms)
room_layout
string or null (RoomLayout)
Enum: "centrally_accessible" "partly_centrally_accessible" "circularly_accessible" "loft"

"centrally_accessible": zentral begehbar
"partly_centrally_accessible": teilweise zentral begehbar
"circularly_accessible": kreisförmig begehbar
"loft": Loft

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 currency property.

see Lookup Tables: RealtyPrices

earnings_per_year_net
number <float>

Nettoertrag pro Jahr

The currency is determined by the realty's currency property.

object

POST Either date or text must be provided and not null.
PATCH The properties date and text can both be null to clear the field.
If both are provided, only date will be set.

category_ids
Array of integers <int64> [ items <int64 > ]
agent_id
required
integer <int64>
object (RealtyTexts)
object or null (InputEnergyPerformanceCertification)

Energieausweis

If a valid_until date is specified, either energy_performance or heating_demand must be provided without null values.

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
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 land_registry_number, cadastral_municipality and plot_number are ignored.

created_at
string <date-time> (WriteCreatedAt)

RFC-3339

If no created_at is provided, the current time will be assumed for it.

ownership_type_id
integer or null (WriteOwnershipTypeId)
furnishing_id
integer or null (WriteFurnishingId)
noise_level_id
integer or null (WriteNoiseLevelId)
location_assessment
string or null (WriteLocationAssessment)
Enum: "very good" "good" "medium" "bad"

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "land_registry_number": "600",
  • "cadastral_municipality": "01010",
  • "plot_number": "1234/1, 1234/2",
  • "type_id": 8,
  • "subtype_id": 80,
  • "occupancy": {
    },
  • "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": {
    },
  • "floors": {
    },
  • "rooms": {
    },
  • "room_layout": "centrally_accessible",
  • "currency": "EUR",
  • "prices": {
    },
  • "earnings_per_year_net": 1234.56,
  • "obtainable_from": {
    },
  • "category_ids": [
    ],
  • "agent_id": 5756,
  • "texts": {
    },
  • "energy_performance_certification": {
    },
  • "feature_ids": [
    ],
  • "accessible": false,
  • "rent_details": {
    },
  • "commission": {
    },
  • "condition_assessment": "very_good",
  • "realty_condition_id": 0,
  • "building_condition_id": 0,
  • "agency_agreement": {
    },
  • "custom_fields": [
    ],
  • "automatic_hits": true,
  • "land_register_entry": {
    },
  • "created_at": "2020-05-01T12:13:25+00:00",
  • "ownership_type_id": 2,
  • "furnishing_id": 2,
  • "noise_level_id": 2,
  • "location_assessment": "very good"
}

Response samples

Content type
application/json
{
  • "id": 939482,
  • "catalogue_number": {
    }
}

Create Realty File

Uploads a file and attaches it to the realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
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 client_credentials_impersonation.

Request Body schema: multipart/form-data
required
file
required
string <binary>
title
string
description
string
group_id
required
string\d+

The group of the file

see Lookup Tables: Realty File GroupId

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:

  • Positive value counts from the start, starting with 0 for the first position, 1 for the second, etc
  • Negative value counts from the end, with -1 as the last position, -2 the second to last, etc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Realty File

Deletes a file attached to a realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
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

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Create Realty Land Register Entry

Attaches a new land register entry to the realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "land_register_entry_number": "600",
  • "cadastral_municipality_id": "01010",
  • "plot_numbers": [
    ],
  • "owner_sequence_numbers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 939482
}

Delete Realty Land Register Entry

Deletes a land register entry attached to a realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

realtyLandRegisterEntryId
required
integer <int64> >= 1

The id of the land register entry

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Attach Realty Vendor

Attaches a contact to a realty as a vendor

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

vendorId
required
integer <int64> >= 1

The id of the vendor

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Detach Realty Vendor

Detaches a vendor from a realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

vendorId
required
integer <int64> >= 1

The id of the vendor

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Contact

Retrieve or manipulate contact related information

List Contacts

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.

Authorizations:
auth_tokenclient_credentials
query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

limit
integer [ 1 .. 100 ]
Default: 10

Max count of items returned at once

offset
integer >= 0
Default: 0

Skip the first offset items

object

Filters the results

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Create Contact

Create an new contact

Authorizations:
auth_tokenclient_credentials_impersonation
header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
type
required
string
email
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"
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 created_at is provided, the current time will be assumed for it.

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 source_id to use for your specific use case.

Responses

Request samples

Content type
application/json
Example
{
  • "type": "company",
  • "email": "support@justimmo.at",
  • "phone_mobile": "0123 4567890",
  • "phone_private": "0123 4567890",
  • "phone_business": "0123 4567890",
  • "address": {
    },
  • "economic_relationship": "family",
  • "vendor_economic_relationship": "none",
  • "category_ids": [
    ],
  • "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
}

Response samples

Content type
application/json
{
  • "id": 939482,
  • "catalogue_number": 15
}

Update Contact

Update an existing contact

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
type
required
string
email
string or null <email>
Deprecated

If the email already exists for this contact, it will be ignored.
If the email doesn't exist yet, it will be added to the existing emails.

To just add an email address, we recommend using the Add Email Address Call instead.
To delete an email address, use the Delete Email Address Call.

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"
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 source_id to use for your specific use case.

Responses

Request samples

Content type
application/json
Example
{
  • "type": "company",
  • "email": "support@justimmo.at",
  • "phone_mobile": "0123 4567890",
  • "phone_private": "0123 4567890",
  • "phone_business": "0123 4567890",
  • "address": {
    },
  • "economic_relationship": "family",
  • "vendor_economic_relationship": "none",
  • "category_ids": [
    ],
  • "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
}

Response samples

Content type
application/json
{ }

Contact Details

Retrieve contact information

Authorizations:
auth_tokenclient_credentials
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
Example
{
  • "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": [
    ],
  • "phone_mobile": "0123 4567890",
  • "phone_private": "0123 4567890",
  • "phone_business": "0123 4567890",
  • "address": {
    },
  • "mailing_address": "Mariahilferstraße 8/11\nA-1070 Wien",
  • "mailing_salutation": "Sehr geehrter Herr Immo",
  • "economic_relationship": "family",
  • "vendor_economic_relationship": "none",
  • "categories": [
    ],
  • "realties": [
    ],
  • "agent": {
    },
  • "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 Contact

Activate an existing contact

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Deactivate Contact

Deactivate an existing contact

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Newsletter Unsubscribe

Unsubscribe from any newsletters the contact may be subscribed to by removing their newsletter categories.

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

query Parameters
categoryId
integer >= 1

ID of the newsletter category to unsubscribe from. If not provided, all newsletters will be unsubscribed

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Add an Email address

Adds an email address to a contact's list of email addresses

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
address
required
string <email>
used_for_communication
required
boolean

Responses

Request samples

Content type
application/json
{
  • "address": "support@justimmo.at",
  • "used_for_communication": true
}

Response samples

Content type
application/json
{
  • "id": 46232
}

Delete Email Address

Deletes an email address from a contact's list of email addresses

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

emailAddressId
required
integer >= 1

The id of the email address

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

List Search Profiles

Retrieve list of search profiles for a contact

Authorizations:
auth_tokenclient_credentials
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

locale
string = 2 characters
Example: locale=de
header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Hitlist

Retrieve hitlist for a contact

Hits are generated based on the users search profiles, but are not specific to them.

Authorizations:
auth_tokenclient_credentials
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

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 offset items

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Commission Contract

Retrieve or manipulate commission contract information

Accept CommissionContract

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.
Authorizations:
auth_tokenclient_credentials
header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Request Body schema: application/json
required
One of
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)

Responses

Request samples

Content type
application/json
Example
{
  • "offer_id": 6578612,
  • "contact_id": 23478439,
  • "accepted_by_ip": "123.123.123.123"
}

Response samples

Content type
application/json
{
  • "id": 576784,
  • "file": {
    }
}

Preview CommissionContract

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.
Authorizations:
auth_tokenclient_credentials
header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Request Body schema: application/json
required
One of
offer_id
required
integer <int64>
contact_id
required
integer <int64>

Responses

Request samples

Content type
application/json
Example
{
  • "offer_id": 6578612,
  • "contact_id": 23478439
}

Response samples

Content type
application/json
{
  • "salutation": "string",
  • "teaser": "string",
  • "text": "string"
}

File

Retrieve file contents

File Content

Retrieve file content

Authorizations:
auth_tokenclient_credentialsclient_credentials_impersonation
path Parameters
storageKey
required
string[a-zA-Z0-9_-]+\.[a-zA-Z0-9]+

The storageKey of the file

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{}

File Thumbnail Content

Retrieve file content of a thumbnail

Authorizations:
auth_tokenclient_credentialsclient_credentials_impersonation
path Parameters
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

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{}

Create Realty File

Uploads a file and attaches it to the realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
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 client_credentials_impersonation.

Request Body schema: multipart/form-data
required
file
required
string <binary>
title
string
description
string
group_id
required
string\d+

The group of the file

see Lookup Tables: Realty File GroupId

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:

  • Positive value counts from the start, starting with 0 for the first position, 1 for the second, etc
  • Negative value counts from the end, with -1 as the last position, -2 the second to last, etc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Realty File

Deletes a file attached to a realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
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

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Update Realty File Metadata

Update an existing realty file's metadata

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
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

header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
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.
Attempting to update a file that's attached to multiple realties will result in response code 422.

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.
Attempting to update a file that's attached to multiple realties will result in response code 422.

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:

  • Positive value counts from the start, starting with 0 for the first position, 1 for the second, etc
  • Negative value counts from the end, with -1 as the last position, -2 the second to last, etc

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "sort_order": 0
}

Response samples

Content type
application/json
{ }

Inquiry

Create general inquiries or inquiries for realties

List Inquiries

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.

Authorizations:
auth_tokenclient_credentials
query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

limit
integer [ 1 .. 100 ]
Default: 10

Max count of items returned at once

offset
integer >= 0
Default: 0

Skip the first offset items

object

Example: filters[contact_id]=123,124
Filters the results

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Create Inquiry

Create an inquiry for a contact and optionally a realty.

Authorizations:
client_credentials
header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Request Body schema: application/json
required
One of
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 true, all recipients configured in this service will receive the financing consultation request via email.

Additional paid service that can be activated in Justimmo.

Responses

Request samples

Content type
application/json
Example
{
  • "contact_id": 23478439,
  • "realty_id": 11104565,
  • "message": "Ich habe Interesse an dieser Wohnung.",
  • "source_id": 0,
  • "agent_id": 5756,
  • "funding_inquiry_request": false
}

Response samples

Content type
application/json
{
  • "id": 24349621,
  • "contact": {
    }
}

Inquiry Details

Retrieve inquiry information

Authorizations:
auth_tokenclient_credentials
path Parameters
inquiryId
required
integer >= 1

The id of the inquiry

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": 7598,
  • "created_at": "2020-05-01T12:13:25+00:00",
  • "message": "string",
  • "agent": {
    },
  • "contact": {
    },
  • "realty": {
    },
  • "source": {
    }
}

Location

Retrieve location autocomplete data

City autocomplete

List cities belonging to a certain zip code.

Authorizations:
auth_tokenclient_credentials
path Parameters
zip
required
integer [ 1000 .. 9999 ]
Example: 1010

The zip code to find matching cities for.

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
[
  • "Wien, Innere Stadt"
]

Combined location autocomplete

Search for locations of all types matching the given query string.

Authorizations:
auth_tokenclient_credentials
path Parameters
query
required
string >= 2 characters
Example: Au

The query string to search for.

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Federal state autocomplete

List federal states for a specific country.

Authorizations:
auth_tokenclient_credentials
path Parameters
iso3
required
string = 3 characters
Example: AUT

The iso3 code of the country to list its federal states.

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Zip autocomplete

Search for valid zips starting with given query string.

Authorizations:
auth_tokenclient_credentials
path Parameters
zip
required
integer [ 10 .. 9999 ]
Example: 10

The zip or partial zip to query for.

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
[
  • 1010
]

Zips in Location

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.

Authorizations:
auth_tokenclient_credentials
query Parameters
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

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Offer

Retrieve offer data

Offer Details

Retrieve offer information

S3 offer storage feature is needed to access offer documents.
Authorizations:
auth_tokenclient_credentials
path Parameters
offerId
required
integer >= 1

The id of the offer

contactId
required
integer <int64> >= 1

The id of the contact

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "offer_id": 5756,
  • "contact": {
    },
  • "tenant_id": 5,
  • "sender": {
    },
  • "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": {
    },
  • "settings": {
    },
  • "realties": [
    ],
  • "attachments": [
    ],
  • "documents": [
    ],
  • "texts": {
    },
  • "commission_assurance": {
    }
}

Offer Attachment Content

Retrieve offer attachment content for files listed in attachments

Authorizations:
auth_token
path Parameters
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

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{}

Search Profile

Retrieve or manipulate search profile related information

List Search Profiles

Retrieve list of search profiles for a contact

Authorizations:
auth_tokenclient_credentials
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

locale
string = 2 characters
Example: locale=de
header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Hitlist

Retrieve hitlist for a contact

Hits are generated based on the users search profiles, but are not specific to them.

Authorizations:
auth_tokenclient_credentials
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

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 offset items

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Hitlist Details

Retrieve information about a hitlist entry

Authorizations:
auth_tokenclient_credentials
path Parameters
contactId
required
integer <int64> >= 1

The id of the contact

realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "contact": {
    },
  • "realty": {
    },
  • "search_profiles": [
    ],
  • "created_at": "1985-04-12 14:12:12"
}

Create Search Profile

Create an new search profile

Authorizations:
auth_tokenclient_credentials_impersonation
header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
contact_id
required
integer <int64>
agent_id
required
integer <int64>

The id of a Justimmo user responsible for managing this profile from here on.

creator_id
integer <int64>
Deprecated

Has to be either the same as contact_id if the profile was created by the contact themselves, or the id of a Justimmo user if the profile was created by an agent.

If no creator_id is provided, it will be assumed the profile has been created by the contact.

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 created_at is provided, the current time will be assumed for it.

required
object (CreateSearchProfileCriteria)

Criteria for potential matches
Availability of certain properties depends on the selected types. required properties are always present.

automatic_hits
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "contact_id": 5756,
  • "agent_id": 5756,
  • "creator_id": 5756,
  • "expires_in": 3,
  • "notes": "string",
  • "created_at": "2020-05-01T12:13:25+00:00",
  • "criteria": {
    },
  • "automatic_hits": false
}

Response samples

Content type
application/json
{
  • "id": 763425
}

Update Search Profile

Update an existing search profile

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
searchProfileId
required
integer >= 1

The id of the search profile

header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
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 (expires_at) itself. It just determines how much to extend by the next time it is extended.

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
Availability of certain properties depends on the selected types. required properties are always present.

automatic_hits
boolean

Responses

Request samples

Content type
application/json
{
  • "contact_id": 5756,
  • "agent_id": 5756,
  • "expires_in": 3,
  • "extend_expiration": true,
  • "notes": "string",
  • "criteria": {
    },
  • "automatic_hits": true
}

Response samples

Content type
application/json
{ }

Search Profile Details

Retrieve search profile information

Authorizations:
auth_tokenclient_credentials
path Parameters
searchProfileId
required
integer >= 1

The id of the search profile

query Parameters
locale
string = 2 characters
Example: locale=de
header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": 5756,
  • "contact": {
    },
  • "agent": {
    },
  • "creator": {
    },
  • "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": {
    },
  • "automatic_hits": true
}

Delete Search Profile

Deletes a search profile

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
searchProfileId
required
integer >= 1

The id of the search profile

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Activate Search Profile

Activate an existing search profile

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
searchProfileId
required
integer >= 1

The id of the search profile

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Deactivate Search Profile

Deactivate an existing search profile

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
searchProfileId
required
integer >= 1

The id of the search profile

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Extend Search Profile

Extend an existing search profile

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
searchProfileId
required
integer >= 1

The id of the search profile

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Realty

Retrieve or manipulate realty related information

List Realties

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.

Authorizations:
auth_tokenclient_credentialsclient_credentials_impersonation
query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

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 offset items

object

Example: filters[parent_id]=123&filters[system_type]=realty,residential_subunit
Filters the results

marketing_types[]
Array of strings (RealtyMarketingType) >= 0 items
Deprecated
Items Enum: "buy" "rent"

Deprecated: Use filters parameter instead

Filters the results based on the realty marketing_type.

see Value Object: RealtyMarketingType and Lookup Tables: RealtyMarketingType

parent_ids[]
Array of integers >= 0 items
Deprecated

Deprecated: Use filters parameter instead

Filters the results based on the realty parent_id.

status_ids[]
Array of integers >= 0 items
Deprecated

Deprecated: Use filters parameter instead

Filters the results based on the realty status.id.

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 parameter instead

Filters the results based on the realty system_type.

see Value Object: RealtySystemType and Lookup Tables: RealtySystemType

type_ids[]
Array of integers >= 0 items
Deprecated

Deprecated: Use filters parameter instead

Filters the results based on the realty type.id.

see Value Object: RealtyType and Lookup Tables: RealtyType

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Create Realty

Create an new realty

Authorizations:
auth_tokenclient_credentials_impersonation
header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
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 land_register_entry when creating a new realty.

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 land_register_entry when creating a new realty.

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 land_register_entry when creating a new realty.

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"

Objekttyp

see Lookup Tables: RealtySystemType

Currently, only "realty" is supported.

parent_id
integer <int64>

The realty Id of the parent residential or commercial project

Currently unused because system_type "realty" doesn't have a parent

type_id
required
integer

Objektart Id

see Lookup Tables: RealtyType

subtype_id
integer

Subobjektart Id

see Lookup Tables: RealtySubType

required
object

Nutzungsart

At least one of these must be true

marketing_type
required
string (RealtyMarketingType)
Enum: "buy" "rent"
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 (RealtyFloors)
object or null (WriteRooms)
room_layout
string or null (RoomLayout)
Enum: "centrally_accessible" "partly_centrally_accessible" "circularly_accessible" "loft"

"centrally_accessible": zentral begehbar
"partly_centrally_accessible": teilweise zentral begehbar
"circularly_accessible": kreisförmig begehbar
"loft": Loft

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 currency property.

see Lookup Tables: RealtyPrices

earnings_per_year_net
number <float>

Nettoertrag pro Jahr

The currency is determined by the realty's currency property.

object

POST Either date or text must be provided and not null.
PATCH The properties date and text can both be null to clear the field.
If both are provided, only date will be set.

category_ids
Array of integers <int64> [ items <int64 > ]
agent_id
required
integer <int64>
object (RealtyTexts)
object or null (InputEnergyPerformanceCertification)

Energieausweis

If a valid_until date is specified, either energy_performance or heating_demand must be provided without null values.

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"
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
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 land_registry_number, cadastral_municipality and plot_number are ignored.

created_at
string <date-time> (WriteCreatedAt)

RFC-3339

If no created_at is provided, the current time will be assumed for it.

ownership_type_id
integer or null (WriteOwnershipTypeId)
furnishing_id
integer or null (WriteFurnishingId)
noise_level_id
integer or null (WriteNoiseLevelId)
location_assessment
string or null (WriteLocationAssessment)
Enum: "very good" "good" "medium" "bad"

Responses

Request samples

Content type
application/json
{
  • "catalogue_number_plain": 123,
  • "address": {
    },
  • "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": {
    },
  • "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": {
    },
  • "floors": {
    },
  • "rooms": {
    },
  • "room_layout": "centrally_accessible",
  • "currency": "EUR",
  • "prices": {
    },
  • "earnings_per_year_net": 1234.56,
  • "obtainable_from": {
    },
  • "category_ids": [
    ],
  • "agent_id": 5756,
  • "texts": {
    },
  • "energy_performance_certification": {
    },
  • "feature_ids": [
    ],
  • "accessible": false,
  • "vendor_economic_relationship": "none",
  • "rent_details": {
    },
  • "commission": {
    },
  • "dual_brokerage": true,
  • "condition_assessment": "very_good",
  • "realty_condition_id": 0,
  • "building_condition_id": 0,
  • "agency_agreement": {
    },
  • "custom_fields": [
    ],
  • "automatic_hits": true,
  • "land_register_entry": {
    },
  • "created_at": "2020-05-01T12:13:25+00:00",
  • "ownership_type_id": 2,
  • "furnishing_id": 2,
  • "noise_level_id": 2,
  • "location_assessment": "very good"
}

Response samples

Content type
application/json
{
  • "id": 939482,
  • "catalogue_number": {
    }
}

Update Realty

Update an existing realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
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 land_register_entry when creating a new realty.

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 land_register_entry when creating a new realty.

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 land_register_entry when creating a new realty.

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"

Objekttyp

see Lookup Tables: RealtySystemType

Currently, only "realty" is supported.

parent_id
integer <int64>

The realty Id of the parent residential or commercial project

Currently unused because system_type "realty" doesn't have a parent

type_id
integer

Objektart Id

see Lookup Tables: RealtyType

subtype_id
integer

Subobjektart Id

see Lookup Tables: RealtySubType

object

Nutzungsart

At least one of these must be true

marketing_type
string (RealtyMarketingType)
Enum: "buy" "rent"
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 (RealtyFloors)
object or null (WriteRooms)
room_layout
string or null (RoomLayout)
Enum: "centrally_accessible" "partly_centrally_accessible" "circularly_accessible" "loft"

"centrally_accessible": zentral begehbar
"partly_centrally_accessible": teilweise zentral begehbar
"circularly_accessible": kreisförmig begehbar
"loft": Loft

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 currency property.

see Lookup Tables: RealtyPrices

earnings_per_year_net
number or null <float>

Nettoertrag pro Jahr

The currency is determined by the realty's currency property.

object

POST Either date or text must be provided and not null.
PATCH The properties date and text can both be null to clear the field.
If both are provided, only date will be set.

category_ids
Array of integers <int64> [ items <int64 > ]
agent_id
integer <int64>
object (RealtyTexts)
object or null (InputEnergyPerformanceCertification)

Energieausweis

If a valid_until date is specified, either energy_performance or heating_demand must be provided without null values.

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"
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
object (RealtyAgencyAgreement)
Array of objects (CustomField)
automatic_hits
boolean
ownership_type_id
integer or null (WriteOwnershipTypeId)
furnishing_id
integer or null (WriteFurnishingId)
noise_level_id
integer or null (WriteNoiseLevelId)
location_assessment
string or null (WriteLocationAssessment)
Enum: "very good" "good" "medium" "bad"

Responses

Request samples

Content type
application/json
{
  • "catalogue_number_plain": 123,
  • "address": {
    },
  • "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": {
    },
  • "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": {
    },
  • "floors": {
    },
  • "rooms": {
    },
  • "room_layout": "centrally_accessible",
  • "currency": "EUR",
  • "prices": {
    },
  • "earnings_per_year_net": 1234.56,
  • "obtainable_from": {
    },
  • "category_ids": [
    ],
  • "agent_id": 5756,
  • "texts": {
    },
  • "energy_performance_certification": {
    },
  • "feature_ids": [
    ],
  • "accessible": false,
  • "vendor_economic_relationship": "none",
  • "rent_details": {
    },
  • "commission": {
    },
  • "dual_brokerage": true,
  • "condition_assessment": "very_good",
  • "realty_condition_id": 0,
  • "building_condition_id": 0,
  • "agency_agreement": {
    },
  • "custom_fields": [
    ],
  • "automatic_hits": true,
  • "ownership_type_id": 2,
  • "furnishing_id": 2,
  • "noise_level_id": 2,
  • "location_assessment": "very good"
}

Response samples

Content type
application/json
{ }

Realty Details

Retrieve realty information

Authorizations:
auth_tokenclient_credentials
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

query Parameters
locale
string = 2 characters
Example: locale=de
header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "status": {
    },
  • "conclusion": {
    },
  • "address": {
    },
  • "public_address": {
    },
  • "land_registry_number": "600",
  • "cadastral_municipality": "01010",
  • "plot_number": "1234/1, 1234/2",
  • "system_type": "realty",
  • "parent_id": 5755,
  • "type": {
    },
  • "subtype": {
    },
  • "occupancy": {
    },
  • "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": {
    },
  • "floors": {
    },
  • "rooms": {
    },
  • "room_layout": "centrally_accessible",
  • "prices": {
    },
  • "earnings_per_year": {
    },
  • "obtainable_from": {
    },
  • "preview_image": {},
  • "preview_plan": {},
  • "categories": [
    ],
  • "custom_fields": [
    ],
  • "agent": {
    },
  • "active_for_export": true,
  • "accessible": true,
  • "contacts": [
    ],
  • "files": [
    ],
  • "internal_files": [
    ],
  • "texts": {
    },
  • "energy_performance_certification": {
    },
  • "features": [
    ],
  • "links": [],
  • "residential_aggregation_data": {
    },
  • "commission": {
    },
  • "vendor_economic_relationship": "none",
  • "dual_brokerage": true,
  • "condition_assessment": "very_good",
  • "realty_condition": {
    },
  • "building_condition": {
    },
  • "is_public": true,
  • "agency_agreement": {
    },
  • "automatic_hits": true,
  • "rent_details": {
    },
  • "land_register_entries": [
    ],
  • "ownership_type": {
    },
  • "furnishing": {
    },
  • "noise_level": {
    },
  • "location_assessment": {
    }
}

List Realty Activities

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.

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

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 offset items

object

Filters the results

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Realty Exports

Retrieve an list of available export feeds for this realty and their status

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "exports": [
    ]
}

Update Realty Exports

toggle the status of realty exports

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
active
boolean

Exporte aktivieren

Array of objects

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "exports": [
    ]
}

Response samples

Content type
application/json
{ }

Realty Export Log

Retrieve an export log for the realty detailing at what times the realty was exported to export feeds.

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

limit
integer [ 1 .. 100 ]
Default: 10

Max count of items returned at once

offset
integer >= 0
Default: 0

Skip the first offset items

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Create Realty File

Uploads a file and attaches it to the realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
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 client_credentials_impersonation.

Request Body schema: multipart/form-data
required
file
required
string <binary>
title
string
description
string
group_id
required
string\d+

The group of the file

see Lookup Tables: Realty File GroupId

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:

  • Positive value counts from the start, starting with 0 for the first position, 1 for the second, etc
  • Negative value counts from the end, with -1 as the last position, -2 the second to last, etc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Realty File Content Deprecated

Retrieve realty file content for files listed in internal_files

Authorizations:
auth_token
path Parameters
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

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{}

Delete Realty File

Deletes a file attached to a realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
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

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Realty Expose Content

Retrieve realty expose content for exposes available for the tenant

Authorizations:
auth_token
path Parameters
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.

query Parameters
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.

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{}

Update Realty File Metadata

Update an existing realty file's metadata

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
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

header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
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.
Attempting to update a file that's attached to multiple realties will result in response code 422.

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.
Attempting to update a file that's attached to multiple realties will result in response code 422.

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:

  • Positive value counts from the start, starting with 0 for the first position, 1 for the second, etc
  • Negative value counts from the end, with -1 as the last position, -2 the second to last, etc

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "sort_order": 0
}

Response samples

Content type
application/json
{ }

Activate Draft

Start marketing for a draft realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Create Realty Land Register Entry

Attaches a new land register entry to the realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "land_register_entry_number": "600",
  • "cadastral_municipality_id": "01010",
  • "plot_numbers": [
    ],
  • "owner_sequence_numbers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 939482
}

Delete Realty Land Register Entry

Deletes a land register entry attached to a realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

realtyLandRegisterEntryId
required
integer <int64> >= 1

The id of the land register entry

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Realty OpenImmo

Retrieve realty information in format OpenImmo 1.2.7 AT2

Authorizations:
auth_tokenclient_credentials
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
text/xml
<?xml version="1.0" encoding="UTF-8"?>
<openimmo>
    ...
</openimmo>
</xml>

Realty POI categories

Retrieve the distance of to the nearest point of interest grouped by groups

Authorizations:
auth_tokenclient_credentials
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

query Parameters
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

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Attach Realty Vendor

Attaches a contact to a realty as a vendor

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

vendorId
required
integer <int64> >= 1

The id of the vendor

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

Detach Realty Vendor

Detaches a vendor from a realty

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
realtyId
required
integer <int64> >= 1

The id of the realty

vendorId
required
integer <int64> >= 1

The id of the vendor

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

List Features

"Ausstattungsmerkmale"

Retrieve available realty features

Authorizations:
auth_tokenclient_credentials
query Parameters
locale
string = 2 characters
Example: locale=de
header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

User

Retrieve user related information

Current User

Retrieve information about current user

Authorizations:
auth_token

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "position": "string",
  • "immobiliencard_id": "AT01234567",
  • "immobiliencard_uid": "string",
  • "foreign_id": 1234,
  • "role": "employee",
  • "permissions": {
    },
  • "tenant": {
    }
}

List Users

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.

Authorizations:
auth_tokenclient_credentials
query Parameters
fields
required
string
Example: fields=*

Comma-separated list of fields to query for each item or * for all
Currently only * is implemented

limit
integer [ 1 .. 100 ]
Default: 10

Max count of items returned at once

offset
integer >= 0
Default: 0

Skip the first offset items

object

Example: filters[foreign_id]=123,124
Filters the results

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Webhooks

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.

Activity events Webhook

Called if one of the activity events registered to a specific webhook is fired

header Parameters
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

Request Body schema: application/json
Array
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

Request samples

Content type
application/json
[
  • {
    }
]

Contact events Webhook

Called if one of the contact events registered to a specific webhook is fired

header Parameters
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

Request Body schema: application/json
Array
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

Request samples

Content type
application/json
[
  • {
    }
]

Hit events Webhook

Called if one of the hit events registered to a specific webhook is fired

header Parameters
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

Request Body schema: application/json
Array
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

Request samples

Content type
application/json
[
  • {
    }
]

Import events Webhook

Called after a openimmo xml uploaded to an ftp server has been imported

header Parameters
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

Request Body schema: application/json
Array
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

Request samples

Content type
application/json
[
  • {
    }
]

Inquiry events Webhook

Called if one of the inquiry events registered to a specific webhook is fired

header Parameters
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

Request Body schema: application/json
Array
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

Request samples

Content type
application/json
[
  • {
    }
]

Newsletter events Webhook

Called if one of the newsletter events registered to a specific webhook is fired.
Newsletter Subscriptions are tied to the presence of a newsletter category on a contact.

header Parameters
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

Request Body schema: application/json
Array
event
required
string
Enum: "newsletter:subscribe" "newsletter:unsubscribe"

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

Request samples

Content type
application/json
[
  • {
    }
]

Realty events Webhook

Called if one of the realty events registered to a specific webhook is fired

header Parameters
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

Request Body schema: application/json
Array
One of
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

Request samples

Content type
application/json
[
  • {
    }
]

Search profile events Webhook

Called if one of the search profile events registered to a specific webhook is fired

header Parameters
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

Request Body schema: application/json
Array
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

Request samples

Content type
application/json
[
  • {
    }
]

List webhooks

Retrieve an list of all registered webhooks for this client and tenant

Authorizations:
auth_tokenclient_credentials_impersonation
header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create webhook

Create a new webhook

Authorizations:
auth_tokenclient_credentials_impersonation
header Parameters
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 client_credentials_impersonation.

Request Body schema: application/json
required
endpoint
required
string <url>
events
required
Array of strings

Please contact us to inquire what events you can use for your specific use case.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "0194dbe2-85b8-7598-9e40-62092ca9d86b",
  • "secret": "string"
}

List webhook deliveries

Retrieve a list of all deliveries of a webhook. Only deliveries of the last 15 days are available

Authorizations:
auth_tokenclient_credentials
path Parameters
webhookId
required
string <uuid>

The id of the webhook

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

Max count of items returned at once

offset
integer >= 0
Default: 0

Skip the first offset items

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

header Parameters
X-Justimmo-TenantId
required
integer
Example: 1372

This is necessary to determine which tenant's data to operate on.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Delete Webhook

Deletes a webhook and all the deliveries for this webhook - sent as well as unset ones.

Authorizations:
auth_tokenclient_credentials_impersonation
path Parameters
webhookId
required
string <uuid>

The id of the webhook

header Parameters
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 client_credentials_impersonation.

Responses

Response samples

Content type
application/json
{ }

ContactEconomicRelationship

Deprecated

Due to the recent change in the Austrian brokerage law act (Erstauftraggeberprinzip), this property is being phased out and replaced with VendorEconomicRelationship.
Information about dual_brokerage (Doppelmaklertätigkeit) is now separately available for read and write in the Realty context.
Value Naheverhältnis
family familiär
family_double_agent familiär mit Doppelmaklertätigkeit
economic wirtschaftlich
economic_double_agent wirtschaftlich mit Doppelmaklertätigkeit

RealtyAreas

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

RealtyRooms

Value Description Value Type
rooms "Anzahl Zimmer" float
toilets "Anzahl WC" int
bathrooms "Anzahl Bäder" int
storerooms "Anzahl Abstellräume" int

RealtyMarketingType

Value Vermarktungsart
buy "Kauf"
rent "Miete/Pacht"

RealtyPrices

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.

RealtyStatus

ID Name
4 "Entwurf"
5 "aktiv"
6 "inaktiv (Deprecated)"
7 "reserviert"
8 "vermittelt"
9 "storniert"
10 "fremdvermittelt"
11 "Vertragserrichtung"

RealtySystemType

Value Objekttyp
realty "Eigenständiges Objekt"
residential_project "Wohnbauprojekt"
residential_subunit "Wohnbauprojekt Untereinheit"
commercial_project "Gewerbeprojekt"
commercial_area "Gewerbeprojekt Fläche"

RealtyType

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

RealtySubType

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.

Zimmer

None

Wohnung

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

Haus

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

Grundstück

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

Büro / Praxis

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

Einzelhandel

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

Gastgewerbe

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

Industrie / Gewerbe

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

Land und Forstwirtschaft

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

Sonstige / Sonderobjekte

ID Name OpenImmo Key
89 Krankenhaus KRANKENHAUS
97 Parkhaus PARKHAUS
98 Tankstelle TANKSTELLE
101 Sonstige SONSTIGE

Freizeitimmobilie gewerblich

ID Name OpenImmo Key
66 Sportanlagen SPORTANLAGEN
67 Vergnügungsparks / -center VERGNUEGUNGSPARKS_UND_CENTER
150 Freizeitanlage FREIZEITANLAGE

Zinshaus / Renditeobjekt

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

Parken

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

RealtyCondition

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

RealtyBuildingCondition

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

RealtyFurnishing

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

RealtyAgencyAgreementType

Value Description
sole_agency_agreement Alleinvermittlungsauftrag
co_sole_agency_agreement Co-Alleinvermittlungsauftrag
simple_agency_agreement schlichter Vermittlungsauftrag

RealtyAgencyAgreementMethod

Value Description
verbal mündlich
written schriftlich
written_bilateral schriftlich (beidseitig)

Realty File GroupId

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

RealtyOwnershipType

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

RealtyNoiseLevel

ID Name
1 absolute Ruhelage
2 geringe Beeinträchtigung
3 durchschnittliche Beeinträchtigung
4 Beeinträchtigung gegeben
5 Ruhelage

RealtyLocationAssessment

Value Name
very good sehr gut
good gut
medium mittel
bad schlecht

VendorEconomicRelationship

Value Naheverhältnis
none Kein Naheverhältnis
family_or_economic Familiäres oder wirtschaftliches Naheverhältnis
economic_interconnection Wirtschaftliches Naheverhältnis mit gesellschaftlicher Verflechtung

RealtyCommissionProspectType

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

RealtyCommissionVendorType

Valid values depend on the realty marketing_type

Value Name Buy Rent
percentage_value % des Kaufpreises x
monthly_rent_value x Monatsmieten x
value Wert x x