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 objects or null
createdAtdatetime or null
deletedAtdatetime or null
documentIdstring or nullformat: "uuid"
The id of the lease document
endDatestring or nullformat: "date"
householdobject or null
householdIdstring or nullformat: "uuid"
householdslist of objects or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
makeReadyDatestring or nullformat: "date"
Unit make ready date from Unit table
moveInDatestring or nullformat: "date"

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

moveOutobject or null
moveOutDatestring or nullformat: "date"

Move-out date from the last NoticeToVacate

moveOutIdstring or nullformat: "uuid"
organizationIdstring or nullformat: "uuid"
propertyobject or null
propertyIdstring or nullformat: "uuid"
readableIdstring or null
renewalOfferslist of objects or null
rentAmountdouble or null
rentChangeslist of objects or null
scheduledtransactionslist of objects or null
securityDepositAmountdouble or null
startDatestring or nullformat: "date"
turnMoveOutDaysinteger or null
Turn move out days from Property table
unitobject or null
unitIdstring or nullformat: "uuid"
updatedAtdatetime or null