Get a list of private rent deposit types

Prev Next
Get
/api/v1/contracts/conceptprivaterent/deposittypes

Get a list of existing private rent deposit types.

Get a list of private rent deposit types

This endpoint retrieves the list of deposit types available for residential lease contracts in Bloxs.

A developer calls this endpoint to look up the valid values before setting the deposit type on a concept residential lease contract, since depositTypeName 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 deposit type.

Security
Responses
200

OK

Array of object
object
name
string | null