Introduction

RealEstateObjects V1

Authentication

To access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key.

CRUD Operations

The API supports CRUD operations for the following real estate object types:

•  Buildings: A building is a standalone entity. It refers to a row house or an entire building that is not divided into multiple parts. A building is a rentable unit. If it contains multiple rental units, it is no longer considered a single building. A building can be included in a rental contract.

• Complexes: A collection of rentable units. This is often under one roof but not necessarily. Example of not being under one roof: the employee housing site from a company, where all the different buildings are considered buildings within a complex. Typically, they are under one roof.

• Sections: This refers to sections of a building. Example: A complex containing a building with a shop on the ground floor and three apartments above it. This is a combination of commercial real estate and residential living. Another example: In a large apartment complex (40 apartments), you could create a section per floor. This is especially important for the allocation of service costs. For instance, the ground floor shouldn't pay for the elevator, or the first floor shouldn't pay for the lighting on the fifth floor. Another example: Multiple Homeowners Associations (HOAs) within one complex, hence the need to create sections to divide HOA costs. It is crucial to set this up correctly as it forms the foundation of the object structure in Bloxs: proper cost allocation, reporting purposes, assignment of a 'concierge,' and creation of (service) notifications.

• Units: An unit can be included in a rental contract. It is part of a larger entity, consisting of multiple units that can also be rented. Examples include a room in a student house or an apartment in a townhouse in Amsterdam. A unit always belongs to a complex, and optionally to a building section. A unit is either part of a complex or part of a building section; it cannot be part of both.

For each object type, the following operations are available:

• GET: Retrieve a list or apply filters.

• POST: Add a new entry or apply filters.

• PUT: Update existing details.

• DELETE: Delete existing details.

Moreover, in the nearby future the following operation will become available:

• PATCH: Apply partial updates.

Thank you for choosing our RealEstateObjects API. If you have any questions or need assistance, please contact our support team.