Skip to main content
GET
contract_ends

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
required

Filter by property_id (required — this table must be filtered to avoid full dataset scans)

floor_area_id
string

Filter by floor_area_id

contract_end_date
string

Filter by contract_end_date

Response

Successful Response

floor_area_person_id
integer
floor_area_id
integer
property_id
string
date
string<date-time>
contract_end_date
string<date>
controct_prolongation_months
integer
contract_end_new
string<date>
request_date
string<date>
response_deadline
string<date>
tenant_response_date
string<date>
response_type
integer
option_deadline
string<date>
deadline_lead_time
integer
auto_use_option
boolean
options_used
integer
options_not_used
integer
start_date
string<date>
end_date
string<date>
bk_contract_ends
string
sk_contract_ends
integer