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