> ## 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 a private rent contract > Get an existing private rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the private rent contract. ## OpenAPI ````json GET /api/v1/contracts/privaterent { "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": { "get": { "tags": [ "PrivateRentContracts" ], "summary": "Get a private rent contract", "description": "Get an existing private rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the private rent contract.", "operationId": "GetPrivateRentContract", "parameters": [ { "name": "reference", "in": "query", "description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).", "schema": { "type": "string" } }, { "name": "externalIdentifier", "in": "query", "description": "The external API identifier of the model.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivateRentContract" } } } }, "404": { "description": "The requested private rent contract was not found." } }, "x-d360-narrative-url": "

Get a private rent contract

Retrieves an existing, finalized residential lease contract from the Bloxs database.

This endpoint applies only to contracts that have already been finalized in the Bloxs application. Concept contracts that have not yet been finalized are retrieved through the corresponding Get a concept private rent contract endpoint instead.

A developer calls this endpoint after a contract has been signed and finalized, to pull the confirmed contract details into a third-party application. Either the contract's reference or its external identifier must be supplied to identify the contract.

Request Fields

Field

Type

Required

Description

reference

string

No

The reference of the residential lease contract, as generated by Bloxs. Maximum length 100 characters.

externalIdentifier

string

No

The external identifier of the residential lease contract, assigned by the requesting party. This identifier is not generated by Bloxs. Maximum length 100 characters.

Response Fields

Field

Type

Required

Description

reference

string

No

The reference of the residential lease contract, as generated by Bloxs. Maximum length 100 characters.

externalIdentifier

string

No

The external identifier of the residential lease contract, assigned by the requesting party. Maximum length 100 characters.

ownerReference

string

No

The reference of the owner of the real estate object that is subject to the contract. Maximum length 100 characters.

relationReference

string

No

The reference of the tenant who is the primary, financially responsible party on the contract. Maximum length 100 characters.

extraRelationReferences

string

No

The references of co-tenants on the contract. When there is more than one co-tenant, the references are combined into a single comma-separated string, for example \"R-00572, R-00510, R-00742\". Maximum length 100 characters.

startDate

string (date-time)

Yes

The start date of the contract. ISO 8601 date-time format.

endDate

string (date-time)

No

The end date of the contract, or the date on which it is automatically renewed when automaticExtends is true. Empty when no end date has been set. ISO 8601 date-time format.

automaticExtends

boolean

Yes

Whether the contract renews automatically. Default value is false.

noticeDate

string (date-time)

No

The latest date on which the contract can be cancelled before an automatic extension takes effect. Only relevant when automaticExtends is true. Calculated by Bloxs from noticePeriod and endDate, and left empty when endDate is empty. ISO 8601 date-time format.

noticePeriod

integer (int32)

No

The notice period of the contract, in months. Only relevant when automaticExtends is true.

lastModified

string (date-time)

Yes

The timestamp of the last modification to the contract within Bloxs. ISO 8601 date-time format.

depositTypeName

string

No

The name of the deposit type registered for the contract. Maximum length 256 characters.

depositAmount

number (double)

No

The deposit amount registered for the contract. Decimals are separated with a period.

" } } }, "components": { "schemas": { "PrivateRentContract": { "type": "object", "properties": { "reference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "externalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "ownerReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "relationReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "extraRelationReferences": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "automaticExtends": { "type": "boolean" }, "noticeDate": { "type": "string", "format": "date-time", "nullable": true }, "noticePeriod": { "type": "integer", "format": "int32", "nullable": true }, "lastModified": { "type": "string", "format": "date-time" }, "depositTypeName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "depositAmount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false } } } } ````