Get a paged list of existing concept private rent contracts, optionally filtered to the given parameters.
Get concept private rent contracts filtered and paged (POST)
This endpoint retrieves a paged list of concept (draft) private rent contracts, optionally filtered on identifiers, parties, indexation method, and date ranges.
It is intended for finding multiple draft contracts at once, for example to check which drafts still need to be completed in the Bloxs application before signing.
To retrieve a single concept contract by its identifier, use the dedicated get endpoint instead of this filtered list.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
paging.pageSize | integer (int32) or null | No | Maximum number of results returned per page. Defaults to 100 when omitted. Maximum value is 1000. |
paging.pageNumber | integer (int32) or null | No | The page number to retrieve, starting at 1. Maximum value is 9999. |
sorting.columnName | string or null | No | The name of the field to sort the results on, for example name. Field names correspond to the response field names in this endpoint's result. |
sorting.order | integer (int32) | No | The sort direction applied to sorting.columnName. Valid values are 0 (ascending) and 1 (descending). Example: 0. |
filter.externalIdentifier | string or null | No | Filters to the concept contract with this external identifier, as assigned by the requesting party. Not generated by Bloxs. |
filter.name | string or null | No | Filters on the free-text name field of the contract, used for search purposes. |
filter.ownerReference | string or null | No | Filters on the reference of the real estate object owner on the contract. |
filter.relationReference | string or null | No | Filters on the reference of the primary tenant who is financially responsible for the contract. |
filter.indexationMethod | string or null | No | Filters on the name of the indexation method applied to the contract. Available methods can be retrieved through the private rent indexation methods lookup endpoint. |
filter.startDate.from | string (date-time) or null | No | Lower bound of the contract start date range, in ISO 8601 date-time format, UTC. Example: 2026-10-01T00:00:00Z. |
filter.startDate.to | string (date-time) or null | No | Upper bound of the contract start date range, in ISO 8601 date-time format, UTC. |
filter.endDate.from | string (date-time) or null | No | Lower bound of the contract end date range, in ISO 8601 date-time format, UTC. |
filter.endDate.to | string (date-time) or null | No | Upper bound of the contract end date range, in ISO 8601 date-time format, UTC. |
filter.nextIndexDate.from | string (date-time) or null | No | Lower bound of the next indexation date range, in ISO 8601 date-time format, UTC. Indexation recurs annually from this date, for example 2026-01-01 followed by 2027-01-01. |
filter.nextIndexDate.to | string (date-time) or null | No | Upper bound of the next indexation date range, in ISO 8601 date-time format, UTC. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
paging.pageSize | integer (int32) or null | No | The number of results returned per page for this response. |
paging.pageNumber | integer (int32) or null | No | The page number of results returned in this response. |
sorting.columnName | string or null | No | The field the results were sorted on. |
sorting.order | integer (int32) | No | The sort direction applied to the results. Valid values are 0 (ascending) and 1 (descending). |
conceptSalesContracts | array or null | No | The list of concept private rent contracts matching the filter. Empty or null when no contracts match. |
conceptSalesContracts.externalIdentifier | string or null | No | The external identifier of the concept private rent contract, as assigned by the requesting party. |
conceptSalesContracts.name | string or null | No | The free name field of the contract. |
conceptSalesContracts.ownerReference | string or null | No | The reference of the real estate object owner on the contract. |
conceptSalesContracts.relationReference | string or null | No | The reference of the primary tenant who is financially responsible for the contract. |
conceptSalesContracts.paymentTerm | string or null | No | The label of the payment term configured for the contract. This is a display label, not the number of days used in payment calculations, which is exposed elsewhere as paymentTermInDays. |
conceptSalesContracts.indexationMethod | string or null | No | The name of the indexation method applied to the contract. |
conceptSalesContracts.startDate | string (date) or null | No | Start date of the contract, formatted as an ISO 8601 date (YYYY-MM-DD). |
conceptSalesContracts.endDate | string (date) or null | No | End date of the contract, formatted as an ISO 8601 date (YYYY-MM-DD). |
conceptSalesContracts.nextIndexDate | string (date) or null | No | The next date from which the indexation method will be applied, formatted as an ISO 8601 date (YYYY-MM-DD). |
Ascending = 0 Descending = 1
OK
Ascending = 0 Descending = 1