API ReferenceProperties

Read Property Configuration

The extended configuration record for a property: marketing copy, contact routing, resident-facing links, leasing and application settings, master metered utilities, service vendors and site details. A property has exactly one configuration, and this endpoint follows the subresource convention, so the response is an array holding that single object. To read it as a bare object instead, call `/propertyConfigurations/{propertyConfigurationId}` — a property's configuration id is the same as its property id. <Note> Three fields flatten a one-to-many relationship into a delimited string: `amenities` (comma-and-space separated), `officeHours` (semicolon separated) and `allowedLeaseTermMonths` (comma separated). Each is an **unordered set** — sort client-side if order matters. `lateFeeMethod` and `securityDepositSimpleInterestRate` reflect the value in effect today, since both are kept as a dated history on the property. </Note>

Path parameters

propertyIdstringRequired
The id of the property

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

An array holding the property's configuration
acceptingOnlineApplicationsbooleanOptional
Whether the property is currently accepting online applications
accountantNamestringOptional
Accountant assigned to the property
accrueSecurityDepositInterestbooleanOptional
Whether the property accrues interest on security deposits
acquisitionDatedatetimeOptional
When ownership purchased the property
allowedLeaseTermMonthsstringOptional

Lease terms the property allows, in months, as a comma-separated list — for example “6,12,18”. An unordered set of distinct values; sort numerically client-side if order matters.

amenitiesstringOptional

Property-level marketing amenities flattened to a comma-and-space separated list — for example “ClubHouse, FitnessCenter, Pool”. An unordered set. Unit and floor-plan amenities are separate; see /properties/{propertyId}/amenities.

apClerkstringOptional
Accounts payable clerk assigned to the property
applicationIncomeRequirementstringOptional

Income requirement applied to applicants, expressed as a multiple of rent — for example “3” meaning three times monthly rent.

applicationPortalUrlstringOptionalformat: "uri"
Resident portal link where applications are taken. Null when the resident portal is not active for the property.
availabilityUrlstringOptionalformat: "uri"

Public unit-availability listing page for the property

buildingProtectionFeeenumOptional
How the building protection fee applies at the property
cableCompanystringOptional
chargesFacilityFeeForLiabilityInsurancebooleanOptional
Whether the property charges a facility fee for liability insurance
clientRepresentativeNamestringOptional
Client representative assigned to the property
countyNamestringOptional
County the property sits in
createdAtdatetimeOptional
currentPeriodstringOptional
The property's current open fiscal period
currentPeriodStartDatedatetimeOptional
Start date of the property's current open fiscal period
deletedAtdatetimeOptional
electricCompanystringOptional
emailstringOptional
Primary email address for the property
emergencyEntranceNoticestringOptional

Notice given before non-emergency entry to a unit

evictionStartDatestringOptional

When the eviction process starts, as free text — for example “by 3:00 pm on the 15th”.

facilitiesFeeAmountintegerOptional
Amount of the facilities fee, when one is charged
faxNumberstringOptional
Fax number for the property
feesStartDatedatetimeOptional
Start date that applies to all fees, from the open fiscal period
gasCompanystringOptional
goesOnDaylightSavingsbooleanOptional
Whether the property observes daylight saving time
hasFitnessCenterbooleanOptional
Whether the property has a fitness center
hasGateWithCodebooleanOptional
Whether the property has a gate with an access code
hasPackageDeliverybooleanOptional
Whether the property offers package delivery
hasPoolbooleanOptional
Whether the property has a pool
idstringOptionalformat: "uuid"
idempotencyIdstringOptionalformat: "uuid"
internetCompanystringOptional
lastRenovationDatestringOptional
When the site was last renovated. Free text upstream rather than a strict date.
lateFeeMethodstringOptional

Description of the late fee method in effect today. Properties keep a dated history of methods; this is the one currently active.

leadPaintDisclosurestringOptional
Lead paint disclosure that applies to the site
leaseNoticeToVacateDaysstringOptional

Notice to vacate the lease requires, as free text — for example “60 Days”.

leaseRentPercentagestringOptional

Lease rent percentage, as free text — for example “30%”

managementQuitDatedatetimeOptional
When the management company stopped managing the property
managementTookOverDatedatetimeOptional
When the management company took over the property
marketingUrlstringOptional
The property's own marketing website, when it has one
masterMeteredElectricitybooleanOptional
Electricity is master metered at the property
masterMeteredGasbooleanOptional
Gas is master metered at the property
masterMeteredOtherstringOptional
Any additional master metered utility, as free text
masterMeteredSewerbooleanOptional
Sewer is master metered at the property
masterMeteredTrashbooleanOptional
Trash is master metered at the property
masterMeteredWaterbooleanOptional
Water is master metered at the property
nearestMetroAreastringOptional
Nearest metropolitan area to the property
nonSmokingbooleanOptional

Whether the property is non-smoking

officeAlarmCodestringOptional
Alarm code for the leasing office
officeHoursstringOptional

Structured office hours flattened to a string, one entry per day, entries separated by ”; ” and formatted as “<Day> <openTime>-<closeTime>” — for example “Monday 9:00 AM-6:00 PM; Tuesday 9:00 AM-6:00 PM”. The entries are an unordered set; each keeps its day name, so sort client-side if you need calendar order.

officeHoursDescriptionstringOptional

Free-text office hours as entered by the property

organizationIdstringOptionalformat: "uuid"
parkingDetailDescriptionstringOptional<=500 characters
Parking details as shown to prospects and residents
pestCompanystringOptional
petPolicyDescriptionstringOptional<=500 characters
Pet policy as shown to prospects and residents
petWeightMaxstringOptional
Maximum pet weight the property allows, as free text
phonestringOptional
Voice phone number for the property
physicalCitystringOptional
physicalCountrystringOptional
physicalStatestringOptional

Two-letter state or province code

physicalStreetAddress1stringOptional
physicalStreetAddress2stringOptional
physicalZipstringOptional
propertyobjectOptional
propertyDescriptionstringOptional<=4000 characters
Full marketing description of the property
propertyIdstringOptionalformat: "uuid"
quoteExpirationenumOptional
How long a rent quote stays valid for. This is a duration, not a calendar date.
readableIdstringOptional
securityDepositInterestPayoutFrequencyenumOptional
How often accrued security deposit interest is paid out
securityDepositSimpleInterestRatedoubleOptional
Simple interest rate applied to security deposits, as a percentage, for the rate period in effect today.
shortDescriptionstringOptional

One-line marketing pitch shown above the full description

siteBuiltDatestringOptional
When the site was built. Free text upstream rather than a strict date, so it may hold a year or a partial date.
textingPhoneNumberstringOptional

SMS number for the property. Null unless two-way communication is enabled for the property.

timezonestringOptional

IANA timezone the property operates in, for example ‘America/Chicago’. Null for the small number of properties that have no timezone configured.

trashCompanystringOptional
turnMoveOutDaysintegerOptional

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

updatedAtdatetimeOptional
waterCompanystringOptional