> ## 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 list of private rent indexation methods > Get a list of existing private rent indexation methods. ## OpenAPI ````json GET /api/v1/contracts/conceptprivaterent/indexationmethods { "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/indexationmethods": { "get": { "tags": [ "Admin" ], "summary": "Get a list of private rent indexation methods", "description": "Get a list of existing private rent indexation methods.", "operationId": "GetIndexationMethodsForPrivateRent", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexationMethodModel" } } } } } }, "x-d360-narrative-url": "

Get a list of private rent indexation methods

This endpoint retrieves the list of indexation methods available for residential lease contracts in Bloxs, for example a fixed percentage, a fixed amount, a statutory rate for a specific segment or a method based on a monthly CPI index with a base value.

This is a generic list that can be edited within the Bloxs application.

A developer calls this endpoint to look up the valid values before setting the indexation method on a concept residential lease contract, since indexationMethodName is one of the fields required to update a concept residential lease contract.


Request Fields

This endpoint takes no request fields.


Response Fields

Field

Type

Required

Description

name

string

No

The name of the indexation method.

" } } }, "components": { "schemas": { "IndexationMethodModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false } } } } ````