> ## 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 private rent contracts filtered and paged > Get a paged list of existing private rent contracts, optionally filtered to the given parameters. ## OpenAPI ````json POST /api/v1/contracts/privaterent/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/privaterent/filter": { "post": { "tags": [ "PrivateRentContracts" ], "summary": "Get private rent contracts filtered and paged", "description": "Get a paged list of existing private rent contracts, optionally filtered to the given parameters.", "operationId": "GetPrivateRentContractsFilteredPaged", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivateRentSalesContractSearchRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivateRentSalesContractSearchResult" } } } } }, "x-d360-narrative-url": "

Get concept private rent contracts filtered and paged (POST)

This endpoint retrieves a paged, filterable list of concept residential lease contracts.

Developers call it to search across concept residential lease contracts for an administration, for example to build an overview screen of contracts still in preparation, or to locate a specific concept contract before it is finalized into a residential lease contract.

Paging and sorting can be combined with any of the available filters, and every field is optional, so a request with an empty filter returns every concept residential lease contract, paged according to the paging settings.

Request Fields

Field

Type

Required

Description

paging.pageSize

Integer

Optional

Maximum number of concept residential lease contracts returned per page. Minimum 1, maximum 1000.

paging.pageNumber

Integer

Optional

Page number to retrieve, starting at 1. Minimum 1, maximum 9999.

sorting.columnName

String

Optional

Name of the field to sort the results by.

sorting.order

Integer (enum)

Optional

Sort direction. Allowed values: 0 = Ascending, 1 = Descending.

filter.externalIdentifier

String

Optional

Filters on the external identifier of the concept residential lease contract, as supplied by the caller on creation.

filter.name

String

Optional

Filters on the name of the concept residential lease contract.

filter.ownerReference

String

Optional

Filters on the owner, the administration the concept residential lease contract is drawn up for.

filter.relationReference

String

Optional

Filters on the relation, the tenant on the concept residential lease contract.

filter.indexationMethod

String

Optional

Filters on the indexation method used to adjust the base rent over time.

filter.startDate.from

Datetime (ISO 8601)

Optional

Lower bound of the contract start date range to filter on, inclusive.

filter.startDate.to

Datetime (ISO 8601)

Optional

Upper bound of the contract start date range to filter on, inclusive.

filter.endDate.from

Datetime (ISO 8601)

Optional

Lower bound of the contract end date range to filter on, inclusive.

filter.endDate.to

Datetime (ISO 8601)

Optional

Upper bound of the contract end date range to filter on, inclusive.

filter.nextIndexDate.from

Datetime (ISO 8601)

Optional

Lower bound of the next indexation date range to filter on, inclusive.

filter.nextIndexDate.to

Datetime (ISO 8601)

Optional

Upper bound of the next indexation date range to filter on, inclusive.

Response Fields

Field

Type

Required

Description

paging.pageSize

Integer

Optional

Maximum number of concept residential lease contracts returned per page, as applied to this result.

paging.pageNumber

Integer

Optional

Page number returned, as applied to this result.

sorting.columnName

String

Optional

Name of the field the results are sorted by, as applied to this result.

sorting.order

Integer (enum)

Optional

Sort direction applied to this result. Allowed values: 0 = Ascending, 1 = Descending.

conceptSalesContracts

Array of objects

Optional

The concept residential lease contracts matching the filter, for the requested page.

conceptSalesContracts[].externalIdentifier

String

Optional

External identifier of the concept residential lease contract, as supplied by the caller on creation.

conceptSalesContracts[].name

String

Optional

Name of the concept residential lease contract.

conceptSalesContracts[].ownerReference

String

Optional

Reference to the owner, the administration the concept residential lease contract is drawn up for.

conceptSalesContracts[].relationReference

String

Optional

Reference to the relation, the tenant on the concept residential lease contract.

conceptSalesContracts[].paymentTerm

String

Optional

Payment term applied to the concept residential lease contract.

conceptSalesContracts[].indexationMethod

String

Optional

Indexation method used to adjust the base rent over time.

conceptSalesContracts[].startDate

Date (ISO 8601, format YYYY-MM-DD)

Optional

Start date of the concept residential lease contract.

conceptSalesContracts[].endDate

Date (ISO 8601, format YYYY-MM-DD)

Optional

End date of the concept residential lease contract.

conceptSalesContracts[].nextIndexDate

Date (ISO 8601, format YYYY-MM-DD)

Optional

Date of the next indexation of the base rent.

" } } }, "components": { "schemas": { "PrivateRentSalesContractSearchRequest": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingInfo" }, "sorting": { "$ref": "#/components/schemas/SortingInfo" }, "filter": { "$ref": "#/components/schemas/PrivateRentSalesContractSearchRequestFilter" } }, "additionalProperties": false }, "PrivateRentSalesContractSearchResult": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingInfo" }, "sorting": { "$ref": "#/components/schemas/SortingInfo" }, "contracts": { "type": "array", "items": { "$ref": "#/components/schemas/PrivateRentSalesContractSearchResultFilter" }, "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 }, "PrivateRentSalesContractSearchRequestFilter": { "type": "object", "properties": { "externalIdentifier": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "ownerReference": { "type": "string", "nullable": true }, "relationReference": { "type": "string", "nullable": true }, "startDate": { "$ref": "#/components/schemas/CompareFilterModelDateTime" }, "endDate": { "$ref": "#/components/schemas/CompareFilterModelDateTime" }, "isStarted": { "type": "boolean", "nullable": true }, "isEnded": { "type": "boolean", "nullable": true }, "automaticExtends": { "type": "boolean", "nullable": true }, "noticeDate": { "$ref": "#/components/schemas/CompareFilterModelDateTime" }, "noticePeriod": { "type": "integer", "format": "int32", "nullable": true }, "depositTypeName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PrivateRentSalesContractSearchResultFilter": { "type": "object", "properties": { "reference": { "type": "string", "nullable": true }, "externalIdentifier": { "type": "string", "nullable": true }, "ownerReference": { "type": "string", "nullable": true }, "relationReference": { "type": "string", "nullable": true }, "extraRelationReferences": { "type": "array", "items": { "type": "string" }, "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "isStarted": { "type": "boolean" }, "isEnded": { "type": "boolean" }, "automaticExtends": { "type": "boolean", "nullable": true }, "noticeDate": { "type": "string", "format": "date-time", "nullable": true }, "noticePeriod": { "type": "integer", "format": "int32", "nullable": true }, "depositTypeName": { "type": "string", "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 } } } } ````