Get a property overview
Returns everything a property dashboard needs in one call: the property, its rolled-up occupancy and money figures, revenue grouped by month, its owners, units, tenants, open maintenance requests, and the leases that need attention.
Authorization
AuthorizationstringrequiredPath parameters
propertyIdstringrequiredSnowflake id of the property, as a decimal string.
Response
200 · The property and everything hanging off it.
propertyobjectThe property itself, without the money rollups the properties endpoints add.
summaryobjectOccupancy and money roll-ups for this property. All computed.
revenueobjectThe property's books, the same source as the balance endpoint, with the line items rolled into months.
ownersOwner[]The property's owners, each in the same shape the owners endpoints return with an extra ownershipPercentage.
maintenanceRequestsMaintenanceRequest[]Maintenance requests on this property, in the same shape the maintenance endpoints return.
upcomingRenewalLeasesLease[]Leases on this property approaching their end date, in the same shape the leases endpoints return.
outstandingBalanceLeasesLease[]Leases on this property that owe money.
tenantsTenant[]Tenants on this property, in the same shape the tenants endpoints return.
unitsUnit[]Every unit on the property.
expiringLeaseCountsobjectHow the property's leases are spread by how soon they end.
cacheDatestring · date-timeWhen the summary was last recomputed, as a wall clock in the company's timezone with no offset.
401 · The access token is missing, expired, or not for this company.
404 · No property with that id, or it belongs to another company.
The summary is computed from a cache. cacheDate tells you when it was last recomputed; anything that changed after that is not reflected yet.