For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Info for a specific property configuration, returned as a single object.
A property’s configuration id is the same as its property id, so this is the
object-shaped equivalent of /properties/{propertyId}/configuration.
Authentication
x-api-keystring
API Key authentication via header
Path parameters
propertyConfigurationIdstringRequired
The id of the property configuration, which is the property's own id
Response
Expected response to a valid request
propertyDescriptionstring or nullOptional<=4000 characters
Full marketing description of the property
shortDescriptionstring or nullOptional
One-line marketing pitch shown above the full description
officeHoursDescriptionstring or nullOptional
Free-text office hours as entered by the property
officeHoursstring or nullOptional
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.
petPolicyDescriptionstring or nullOptional<=500 characters
Pet policy as shown to prospects and residents
parkingDetailDescriptionstring or nullOptional<=500 characters
Parking details as shown to prospects and residents
amenitiesstring or nullOptional
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.
marketingUrlstring or nullOptional
The property's own marketing website, when it has one
emailstring or nullOptional
Primary email address for the property
phonestring or nullOptional
Voice phone number for the property
faxNumberstring or nullOptional
Fax number for the property
textingPhoneNumberstring or nullOptional
SMS number for the property. Null unless two-way communication is enabled for the property.
physicalStreetAddress1string or nullOptional
physicalStreetAddress2string or nullOptional
physicalCitystring or nullOptional
physicalStatestring or nullOptional
Two-letter state or province code
physicalZipstring or nullOptional
physicalCountrystring or nullOptional
applicationPortalUrlstring or nullOptionalformat: "uri"
Resident portal link where applications are taken. Null when the resident portal is not active for the property.
availabilityUrlstring or nullOptionalformat: "uri"
Public unit-availability listing page for the property
lateFeeMethodstring or nullOptional
Description of the late fee method in effect today. Properties keep a dated history of methods; this is the one currently active.
acceptingOnlineApplicationsboolean or nullOptional
Whether the property is currently accepting online applications
applicationIncomeRequirementstring or nullOptional
Income requirement applied to applicants, expressed as a multiple of rent — for example “3” meaning three times monthly rent.
allowedLeaseTermMonthsstring or nullOptional
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.
quoteExpirationenum or nullOptional
How long a rent quote stays valid for. This is a duration, not a calendar date.
Allowed values:
masterMeteredElectricityboolean or nullOptional
Electricity is master metered at the property
masterMeteredGasboolean or nullOptional
Gas is master metered at the property
masterMeteredSewerboolean or nullOptional
Sewer is master metered at the property
masterMeteredTrashboolean or nullOptional
Trash is master metered at the property
masterMeteredWaterboolean or nullOptional
Water is master metered at the property
masterMeteredOtherstring or nullOptional
Any additional master metered utility, as free text
accrueSecurityDepositInterestboolean or nullOptional
Whether the property accrues interest on security deposits
securityDepositInterestPayoutFrequencyenum or nullOptional
How often accrued security deposit interest is paid out
Allowed values:
securityDepositSimpleInterestRatedouble or nullOptional
Simple interest rate applied to security deposits, as a percentage, for the rate period in effect today.
nearestMetroAreastring or nullOptional
Nearest metropolitan area to the property
timezonestring or nullOptional
IANA timezone the property operates in, for example ‘America/Chicago’. Null for the small number of properties that have no timezone configured.
goesOnDaylightSavingsboolean or nullOptional
Whether the property observes daylight saving time
countyNamestring or nullOptional
County the property sits in
siteBuiltDatestring or nullOptional
When the site was built. Free text upstream rather than a strict date, so it may hold a year or a partial date.
lastRenovationDatestring or nullOptional
When the site was last renovated. Free text upstream rather than a strict date.
managementTookOverDatedatetime or nullOptional
When the management company took over the property
acquisitionDatedatetime or nullOptional
When ownership purchased the property
managementQuitDatedatetime or nullOptional
When the management company stopped managing the property
officeAlarmCodestring or nullOptional
Alarm code for the leasing office
hasGateWithCodeboolean or nullOptional
Whether the property has a gate with an access code
clientRepresentativeNamestring or nullOptional
Client representative assigned to the property
accountantNamestring or nullOptional
Accountant assigned to the property
apClerkstring or nullOptional
Accounts payable clerk assigned to the property
turnMoveOutDaysinteger or nullOptional
Number of days after move-out used to calculate the make ready date
evictionStartDatestring or nullOptional
When the eviction process starts, as free text — for example “by 3:00 pm on the 15th”.
leaseNoticeToVacateDaysstring or nullOptional
Notice to vacate the lease requires, as free text — for example “60 Days”.
emergencyEntranceNoticestring or nullOptional
Notice given before non-emergency entry to a unit
hasFitnessCenterboolean or nullOptional
Whether the property has a fitness center
hasPoolboolean or nullOptional
Whether the property has a pool
hasPackageDeliveryboolean or nullOptional
Whether the property offers package delivery
nonSmokingboolean or nullOptional
Whether the property is non-smoking
petWeightMaxstring or nullOptional
Maximum pet weight the property allows, as free text
leadPaintDisclosurestring or nullOptional
Lead paint disclosure that applies to the site
waterCompanystring or nullOptional
gasCompanystring or nullOptional
electricCompanystring or nullOptional
cableCompanystring or nullOptional
internetCompanystring or nullOptional
pestCompanystring or nullOptional
trashCompanystring or nullOptional
feesStartDatedatetime or nullOptional
Start date that applies to all fees, from the open fiscal period
currentPeriodStartDatedatetime or nullOptional
Start date of the property's current open fiscal period
currentPeriodstring or nullOptional
The property's current open fiscal period
buildingProtectionFeeenum or nullOptional
How the building protection fee applies at the property
Allowed values:
leaseRentPercentagestring or nullOptional
Lease rent percentage, as free text — for example “30%”
chargesFacilityFeeForLiabilityInsuranceboolean or nullOptional
Whether the property charges a facility fee for liability insurance
