Search
K
Property Management

Property Management

1.0.0OAS 3.0

The system of record for every listed property - apartments, houses and
commercial space. Properties are the foundation for listings, matching and
valuation.

The portfolio can be populated and exported via a standard property-data
feed, so existing agency software connects without an extra integration step.

API Base URL
  • Server 1:https://api.realestateagency.example/v1

    Production

  • Server 2:https://sandbox.api.realestateagency.example/v1

    Sandbox

Security
apiKey (apiKey)

Every call carries an API key in the apikey header. You generate the
key in the Real Estate portal under “My Apps”; it’s shown exactly once.

Each key has the scopes it’s allowed to use attached to it. If one is
missing, the API responds with 403 and code: "scope_missing"; the
missing scope is in details[].field.

Additional Information
Contact API Support - Real Estate Agency (api-support@realestateagency.example)

Properties

List properties

get

Query Parameters

statusstring

Allowed values:draftactivereservedsoldrentedarchived

Example:active

typestring

Allowed values:apartmenthouselandcommercialparking

Example:apartment

postal_codestring

Filter by postal code.

Example:10001

limitinteger

Default:25

>= 1<= 100

cursorstring

Response

application/json

Results list

dataarray
Show Child Parameters
pageobject

Cursor-based pagination.

Show Child Parameters
get/properties
 
application/json

Create a property

post

Body

application/json

PropertyInput

typestringrequired

Allowed values:apartmenthouselandcommercialparking

Example:apartment

titlestringrequired

<= 120 characters

Example:3-Bedroom Period Home near Riverside Park

descriptionstring

Example:Well-maintained period apartment on the second floor with two south-facing balconies.

addressobjectrequired
Show Child Parameters
living_area_sqmnumber(float)

Example:86.5

lot_size_sqmnumber(float)

Example:412

roomsnumber(float)

Example:3

year_builtinteger

Example:1908

floorinteger

Example:2

purchase_price_eurinteger

Example:645000

cold_rent_eurinteger

Example:1450

service_charges_eurinteger

Example:280

available_fromstring(date)

Example:2026-11-01

energy_certificateobject

Figures needed to publish a listing.

Show Child Parameters
commissionobject
Show Child Parameters

Response

application/json

Created

Property

typestringrequired

Allowed values:apartmenthouselandcommercialparking

Example:apartment

titlestringrequired

<= 120 characters

Example:3-Bedroom Period Home near Riverside Park

descriptionstring

Example:Well-maintained period apartment on the second floor with two south-facing balconies.

addressobjectrequired
Show Child Parameters
living_area_sqmnumber(float)

Example:86.5

lot_size_sqmnumber(float)

Example:412

roomsnumber(float)

Example:3

year_builtinteger

Example:1908

floorinteger

Example:2

purchase_price_eurinteger

Example:645000

cold_rent_eurinteger

Example:1450

service_charges_eurinteger

Example:280

available_fromstring(date)

Example:2026-11-01

energy_certificateobject

Figures needed to publish a listing.

Show Child Parameters
commissionobject
Show Child Parameters
idstring

Example:prop_8f2c1a

statusstring

Allowed values:draftactivereservedsoldrentedarchived

Example:active

media_countinteger

Example:14

created_atstring(date-time)

Example:2026-08-14T08:12:44Z

updated_atstring(date-time)

Example:2026-08-20T09:38:02Z

post/properties

Body

{ "type": "apartment", "title": "3-Bedroom Period Home near Riverside Park", "address": { "street": "148 Elm Street", "postal_code": "10001", "city": "Springfield" }, "living_area_sqm": 86.5, "rooms": 3, "year_built": 1908, "purchase_price_eur": 645000, "commission": { "buyer_percent": 3.57, "seller_percent": 3.57 } }
 
application/json

Retrieve a property

get

Path Parameters

propertyIdstringrequired

Example:prop_8f2c1a

Response

application/json

Property

Property

typestringrequired

Allowed values:apartmenthouselandcommercialparking

Example:apartment

titlestringrequired

<= 120 characters

Example:3-Bedroom Period Home near Riverside Park

descriptionstring

Example:Well-maintained period apartment on the second floor with two south-facing balconies.

addressobjectrequired
Show Child Parameters
living_area_sqmnumber(float)

Example:86.5

lot_size_sqmnumber(float)

Example:412

roomsnumber(float)

Example:3

year_builtinteger

Example:1908

floorinteger

Example:2

purchase_price_eurinteger

Example:645000

cold_rent_eurinteger

Example:1450

service_charges_eurinteger

Example:280

available_fromstring(date)

Example:2026-11-01

energy_certificateobject

Figures needed to publish a listing.

Show Child Parameters
commissionobject
Show Child Parameters
idstring

Example:prop_8f2c1a

statusstring

Allowed values:draftactivereservedsoldrentedarchived

Example:active

media_countinteger

Example:14

created_atstring(date-time)

Example:2026-08-14T08:12:44Z

updated_atstring(date-time)

Example:2026-08-20T09:38:02Z

get/properties/{propertyId}
 
application/json