Get publication data for a real estate object
- 06 Jun 2025
- 4 Minutes to read
- Print
- DarkLight
Get publication data for a real estate object
- Updated on 06 Jun 2025
- 4 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Get
/api/v1/realestateobjects/publish/object
Get publication data for an existing real estate object. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the data.
Description
An existing real estate object can be published. This means that specified data is accessible for a third party website for publishing. For example, unit x becomes available soon. Therefore the manager of the unit wants to publish the real estate object on a rental website. By publishing the unit, specified data becomes available for a third party website to retrieve through a pull/get.
This endpoint retrieves the data eligible for publishing of a specific real estate object.
Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference.
Use Case
The Bloxs user wants to know whether the data of unit x has been published. By using this endpoint the user can retrieve this information.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| reference | The reference of the real estate object from which the published data needs to be retrieved. This reference is generated by Bloxs. |
| externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
Response fields
The response contains the fields in the table below.
| Field | Description |
|---|---|
| reference | The reference of the real estate object from which the published data needs to be retrieved. This reference is generated by Bloxs. |
| externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| type | The type of real estate object. Examples are unit or complex. |
| complexReference | When retrieving a unit, this field returns the reference to the parent complex. |
| name | A free description of the name of the real estate object. An example can be an office building. Even though the address is 'Office street 24', the official name of the office building is 'Empirium'. The property 'name' can be used to assign this custom name. |
| isPublished | This is a boolean indicating whether the data is published or not. |
| publishedDate | The date on which the real estate object was initially published. Later updates of the data do not influence this date. |
| publishedStatus | Enumeration regarding the status of the real estate object. For example 'available' or 'under option'. |
| availableFrom | The date from which the property is available. |
| categoryName | Category of the object, as defined in the admin list. For example: studio, apartment, commercial space, retail space. The full available list can be retrieved through the GET operation in the relevant object type. |
| addressStreet | The street of the published object. |
| addressCity | The city in which the published object is located. |
| addressPostalCode | The postal code of the published object. |
| addressCountryCode | The country code of the published object. |
| longitude | Geo-coordinates. Recorded as numbers only, using a decimal point (without degree symbols). For example, Amsterdam = 52.3676, 4.9041. |
| latitude | Geo-coordinates. Recorded as numbers only, using a decimal point (without degree symbols). For example, Amsterdam = 52.3676, 4.9041. |
| lastModified | Timestamp of the last modification within Bloxs (determined by Bloxs). |
| lastModified_Publication | Timestamp of the last modification done on one of the custom published properties. |
| properties.property | The name of the custom property. If more custom properties exist for this object, they will be shown as an array. |
| images.imageId | The unique identifier of the image. This ID is generated by Bloxs. |
| images.description | The description of the image, for example 'front view of the garden'. |
| images.order | The order in which the images are displayed in Bloxs. |
| theoreticalRent.contracLineItemName | A user can input in Bloxs the theoretical rental income expected for the property. Contract line items are the possible contract terms. These include costs for the tenant, such as rent, furniture, and rent discounts (negative costs). It is a generic list in Bloxs. This property displays the name of the contract line item related to the theoretical rent. |
| theoreticalRent.amountExcl | A user can input in Bloxs the theoretical rental income expected for the property. Contract line items are the possible contract terms. These include costs for the tenant, such as rent, furniture, and rent discounts (negative costs). It is a generic list in Bloxs. This property displays the amount of the invoice line item, excluding VAT. Decimals are separated with a period (.) |
Security
HTTP
Type Bearer
Please enter a valid token
Query parameters
reference
string
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
externalIdentifier
string
The external API identifier of the model.
Responses
200
OK
object
reference
string
The unique identifier of the Object
Min length1
Max length100
externalIdentifier
string
Min length1
Max length100
type
integer (int32)
Valid values[ 8, 18, 36, 49, 64 ]
complexReference
string | null
The unique identifier of the Complex. This references another Object, which this Object belongs to
Max length100
name
string | null
Max length256
isPublished
boolean
publishedDate
string (date)
publishedStatus
integer (int32)
Valid values[ 0, 1, 2, 3 ]
availableFrom
string (date) | null
categoryName
string | null
addressStreet
string | null
addressCity
string | null
addressPostalCode
string | null
addressCountryCode
string | null
longitude
number (double) | null
latitude
number (double) | null
lastModified
string (date-time)
lastModified_Publication
string (date-time)
properties
object | null
property*
images
Array of object (Image) | null
object
imageId
integer (int64)
description
string | null
Max length256
order
integer (int32)
theoreticalRent
Array of object (TheoreticalRentItem) | null
object
contractLineItemName
string
Min length1
Max length256
amountExcl
number (double)
404
The requested real estate object was not found.