API ReferenceProperties

List Properties

List all properties

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 properties
acquisitionDatedatetime or null
activitieslist of objects or null
amenitieslist of objects or null
applicationslist of objects or null
attachmentslist of objects or null
countyNamestring or null
createdAtdatetime or null
customerslist of objects or null
deletedAtdatetime or null
depositslist of objects or null
documentslist of any or null
emailstring or null<=50 characters
faxNumberstring or null
floorPlanslist of objects or null
glEntrieslist of objects or null
householdslist of objects or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
latitudedouble or null
listingslist of objects or null
longitudedouble or null
mailingCitystring or null
mailingCountrystring or null
mailingStatestring or null
mailingStreetAddress1string or null
mailingStreetAddress2string or null
mailingZipstring or null
maintenanceIssueslist of objects or null
maintenanceLocationslist of objects or null
moveInslist of objects or null
moveOutslist of objects or null
namestring or null
offboardedAtdatetime or null
organizationIdstring or nullformat: "uuid"
phonestring or null
phoneNumberstring or null
physicalCitystring or null
physicalCountrystring or null
physicalStatestring or null
physicalStreetAddress1string or null
physicalStreetAddress2string or null
physicalZipstring or null
prospectslist of objects or null
readableIdstring or null
rentChangeslist of objects or null
rentableItemslist of objects or null
reportslist of objects or null
scheduledTransactionslist of objects or null
shortNamestring or null
timezonestring or null
transactionslist of objects or null
turnMoveOutDaysinteger or null

Number of days after move-out to calculate make ready date

unitStatusChangeslist of objects or null
unitslist of objects or null
updatedAtdatetime or null
userPropertieslist of objects or null
workOrderslist of objects or null