> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Get concept private rent contracts filtered and paged > Get a paged list of existing concept private rent contracts, optionally filtered to the given parameters. ## OpenAPI ````json POST /api/v1/contracts/conceptprivaterent/filter { "openapi": "3.0.4", "info": { "title": "Concept SalesContracts V1", "description": "Welcome to BETA version of the new Sales Concept Contracts API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "CommercialRentContracts" }, { "name": "Concept CommercialRent" }, { "name": "Concept PrivateRent" }, { "name": "GeneralSalesContracts" }, { "name": "Metadata" }, { "name": "PrivateRentContracts" }, { "name": "SupplierContracts" } ], "paths": { "/api/v1/contracts/conceptprivaterent/filter": { "post": { "tags": [ "Concept PrivateRent" ], "summary": "Get concept private rent contracts filtered and paged", "description": "Get a paged list of existing concept private rent contracts, optionally filtered to the given parameters.", "operationId": "GetConceptPrivateRentContractsFilteredPaged", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterConceptSalesContractRequestPagingModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterConceptSalesContractResponsePagingModel" } } } } }, "x-d360-narrative-url": "

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).

" } } }, "components": { "schemas": { "FilterConceptSalesContractRequestPagingModel": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingInfo" }, "sorting": { "$ref": "#/components/schemas/SortingInfo" }, "filter": { "$ref": "#/components/schemas/FilterConceptSalesContractRequestDTO" } }, "additionalProperties": false }, "FilterConceptSalesContractResponsePagingModel": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingInfo" }, "sorting": { "$ref": "#/components/schemas/SortingInfo" }, "conceptSalesContracts": { "type": "array", "items": { "$ref": "#/components/schemas/FilterConceptSalesContractResponseDTO" }, "nullable": true } }, "additionalProperties": false }, "PagingInfo": { "type": "object", "properties": { "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "pageNumber": { "maximum": 9999, "minimum": 1, "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SortingInfo": { "type": "object", "properties": { "columnName": { "type": "string", "nullable": true }, "order": { "type": "integer", "description": "Ascending = 0\nDescending = 1", "format": "int32", "x-enumNames": [ "Ascending", "Descending" ] } }, "additionalProperties": false }, "FilterConceptSalesContractRequestDTO": { "type": "object", "properties": { "externalIdentifier": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "ownerReference": { "type": "string", "nullable": true }, "relationReference": { "type": "string", "nullable": true }, "indexationMethod": { "type": "string", "nullable": true }, "startDate": { "$ref": "#/components/schemas/CompareFilterModelDateTime" }, "endDate": { "$ref": "#/components/schemas/CompareFilterModelDateTime" }, "nextIndexDate": { "$ref": "#/components/schemas/CompareFilterModelDateTime" } }, "additionalProperties": false }, "FilterConceptSalesContractResponseDTO": { "type": "object", "properties": { "externalIdentifier": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "ownerReference": { "type": "string", "nullable": true }, "relationReference": { "type": "string", "nullable": true }, "paymentTerm": { "type": "string", "nullable": true }, "indexationMethod": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "nextIndexDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "CompareFilterModelDateTime": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time", "nullable": true }, "to": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false } } } } ````