Get publication data for a real estate object

reference

string

Conditional

Internal identifier of the object. Either reference or externalIdentifier must be provided. If both are given, the object must match both values.

externalIdentifier

string

Conditional

External identifier of the object, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the object must match both values.

reference

string

Yes

Internal identifier of the object. Maximum length 100 characters.

externalIdentifier

string

Yes

External identifier of the object. Maximum length 100 characters.

type

integer

No

Type of the real estate object. Valid values are 8 (Section), 18 (Complex), 36 (Unit), 49 (Building), or 64 (Project).

complexReference

string

No

Reference of the parent complex. Only populated when the published object is a unit. Maximum length 100 characters.

name

string

No

Custom display name of the object, for use when the address alone is not descriptive enough, for example a named office building. Maximum length 256 characters.

isPublished

boolean

Yes

Indicates whether the object is currently published.

publishedDate

string (date)

Yes

Date the object was initially published. Not affected by later updates to the published data.

publishedStatus

integer

Yes

Publication status of the object. Valid values are 0 (Available), 1 (Reserved), 2 (Rented), or 3 (UnderOption).

availableFrom

string (date)

No

Date from which the object is available. ISO 8601 format.

categoryName

string

No

Category of the object, for example studio, apartment, commercial space, or retail space. The full list is retrievable through the category endpoint of the relevant object type.

addressStreet

string

No

Street of the published object's address.

addressCity

string

No

City of the published object's address.

addressPostalCode

string

No

Postal code of the published object's address.

addressCountryCode

string

No

Country code of the published object's address.

longitude

number (double)

No

Geographic longitude of the object, as a plain decimal number without a degree symbol, for example 4.9041.

latitude

number (double)

No

Geographic latitude of the object, as a plain decimal number without a degree symbol, for example 52.3676.

lastModified

string (date-time)

Yes

Timestamp of the last modification to the object itself. ISO 8601 format, UTC.

lastModified_Publication

string (date-time)

Yes

Timestamp of the last modification made to any of the custom published properties. ISO 8601 format, UTC.

properties

object

No

Custom published properties for the object, as a set of key-value pairs. Each key is the apiLabel of a property definition configured through the property definitions endpoints, and the value is the corresponding data entered for this object. The available keys are not fixed and depend on which property definitions currently exist.

images

array of object

No

Images published for the object. Empty or omitted when no images are published.

images.imageId

integer (int64)

Yes

Internal identifier of the image, generated by Bloxs. Used to retrieve the actual image file through the image endpoint.

images.description

string

No

Description of the image, for example "front view of the garden." Maximum length 256 characters.

images.order

integer

Yes

Display order of the image among the published images for this object.

theoreticalRent

array of object

No

Theoretical rent line items configured for the object, such as rent, furniture, or negative-cost rent discounts. Empty or omitted when none are configured.

theoreticalRent.contractLineItemName

string

Yes

Name of the contract line item this theoretical rent entry represents. Maximum length 256 characters.

theoreticalRent.amountExcl

number (double)

Yes

Amount of the line item, excluding VAT (net amount). Decimals are separated with a period.