Raw schema
{
"type": "object",
"properties": {
"query": {
"description": "Free-text search over unit id, street, zip code, city, district and exposee id.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status_ids": {
"description": "Only properties in one of these status ids (see propstack_get_reference_data property_statuses).",
"minItems": 1,
"maxItems": 30,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"tag_ids": {
"description": "Only properties with one of these tag ids (see propstack_get_reference_data property_tags).",
"minItems": 1,
"maxItems": 30,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"project_id": {
"description": "Only the units of this project id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"marketing_type": {
"description": "Sale or rent.",
"type": "string",
"enum": [
"BUY",
"RENT"
]
},
"rs_type": {
"description": "Property type.",
"type": "string",
"enum": [
"APARTMENT",
"HOUSE",
"TRADE_SITE",
"GARAGE",
"SHORT_TERM_ACCOMODATION",
"OFFICE",
"GASTRONOMY",
"INDUSTRY",
"STORE",
"SPECIAL_PURPOSE",
"INVESTMENT"
]
},
"country": {
"description": "Two-letter ISO country code, e.g. DE.",
"type": "string",
"minLength": 2,
"maxLength": 2
},
"archived": {
"description": "'only' = only archived properties, 'include' = archived and active. Default: active only.",
"type": "string",
"enum": [
"only",
"include"
]
},
"price_from": {
"description": "Minimum purchase price.",
"type": "number",
"minimum": 0
},
"price_to": {
"description": "Maximum purchase price.",
"type": "number",
"minimum": 0
},
"base_rent_from": {
"description": "Minimum cold rent.",
"type": "number",
"minimum": 0
},
"base_rent_to": {
"description": "Maximum cold rent.",
"type": "number",
"minimum": 0
},
"living_space_from": {
"description": "Minimum living space in square metres.",
"type": "number",
"minimum": 0
},
"living_space_to": {
"description": "Maximum living space in square metres.",
"type": "number",
"minimum": 0
},
"rooms_from": {
"description": "Minimum number of rooms.",
"type": "number",
"minimum": 0
},
"rooms_to": {
"description": "Maximum number of rooms.",
"type": "number",
"minimum": 0
},
"sort_by": {
"description": "Sort field.",
"type": "string",
"enum": [
"created_at",
"updated_at",
"price",
"base_rent",
"property_space_value",
"number_of_rooms",
"construction_year"
]
},
"order": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"per": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}