API ReferenceLeases

List Leases

List all Leases

Query parameters

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

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of leases
claimslist of objectsOptional
createdAtdatetimeOptional
deletedAtdatetimeOptional
documentIdstringOptionalformat: "uuid"
The id of the lease document
endDatestringOptionalformat: "date"
householdobjectOptional
householdIdstringOptionalformat: "uuid"
householdslist of objectsOptional
idstringOptionalformat: "uuid"
idempotencyIdstringOptionalformat: "uuid"
leasedRentdoubleOptional
Leased rent amount on the lease
makeReadyDatestringOptionalformat: "date"
Unit make ready date from Unit table
moveInDatestringOptionalformat: "date"

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

moveOutobjectOptional
moveOutDatestringOptionalformat: "date"

Move-out date from the last NoticeToVacate

moveOutIdstringOptionalformat: "uuid"
organizationIdstringOptionalformat: "uuid"
propertyobjectOptional
propertyIdstringOptionalformat: "uuid"
readableIdstringOptional
renewalOfferslist of objectsOptional
rentAmountdoubleOptional
rentChangeslist of objectsOptional
scheduledtransactionslist of objectsOptional
securityDepositAmountdoubleOptional
startDatestringOptionalformat: "date"
turnMoveOutDaysintegerOptional
Turn move out days from Property table
unitobjectOptional
unitIdstringOptionalformat: "uuid"
updatedAtdatetimeOptional