Skip to main content
GET
property_structure

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer
default:1000

Maximum number of rows to return (max 100,000). Use offset for subsequent pages.

Required range: 1 <= x <= 100000
offset
integer
default:0

Number of rows to skip (max 500,000). Use with limit for pagination. Results are returned in a stable order (configured sort key per table, fallback to physical row order) — pages are gapless and duplicate-free as long as the dataset does not change between requests. The response headers X-Total-Count, X-Has-More and X-Next-Offset contain pagination metadata. For large datasets use filters or /raw/{table_name} for full-table exports.

Required range: 0 <= x <= 500000
cursor
string

Opaque pagination cursor from the X-Next-Cursor response header of the previous page. Cannot be combined with offset > 0. When X-Next-Cursor is absent in the response, all rows have been fetched.

property_id
string

Filter by property_id

account_id
string

Filter by account_id

floor_area_id
string

Filter by floor_area_id

account_type
string

Filter by account_type

Response

Successful Response

sk_join_key
integer
property_id
integer
sk_properties
integer
account_id
string
join_key
string
property_id_name
string
property_name
string
account_name
string
floor_area_id
integer
floor_area_nr
string
account_type
string
account_type_short
string
address
string
entrance
string
building_part
string
floor
string
floor_area_name
string
location
string
floor_area_type
string
no_marketing
boolean
target_rent_per_m2
number
market_rent_per_m2
number
heating
string
vacancy_reason
string
vacancy_reason_comment
string
vacancy_reason_begin_date
string<date>
begin_mandate
string<date>
end_mandate
string<date>
floor_area_begin
string<date>
floor_area_end
string<date>
active_from
string<date>
active_to
string<date>
hierarchy_1
string
hierarchy_2
string
hierarchy_3
string
url
string
m2
number
target_rent_total
number
market_rent_total
number
account_id_count
integer