API ReferenceLeases

Read Lease

Info for a specific lease

Path parameters

leaseIdstringRequired
The id of the lease

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request
claimslist of objects
createdAtdatetime
deletedAtdatetime
documentIdstringformat: "uuid"
The id of the lease document
endDatestringformat: "date"
householdobject
householdIdstringformat: "uuid"
householdslist of objects
idstringformat: "uuid"
idempotencyIdstringformat: "uuid"
makeReadyDatestringformat: "date"
Unit make ready date from Unit table
moveInDatestringformat: "date"

Effective move-in date (actualMoveInDate if available, otherwise moveInDate)

moveOutobject
moveOutDatestringformat: "date"

Move-out date from the last NoticeToVacate

moveOutIdstringformat: "uuid"
organizationIdstringformat: "uuid"
propertyobject
propertyIdstringformat: "uuid"
readableIdstring
renewalOfferslist of objects
rentAmountdouble
rentChangeslist of objects
scheduledtransactionslist of objects
securityDepositAmountdouble
startDatestringformat: "date"
turnMoveOutDaysinteger
Turn move out days from Property table
unitobject
unitIdstringformat: "uuid"
updatedAtdatetime