Get several properties by id
Fetches up to 100 hydrated properties in one call. Every id must exist and belong to the company — one bad id fails the whole call.
Authorization
AuthorizationstringrequiredQuery parameters
propertyIdsstring[]requiredThe properties to fetch. Give them comma-separated (propertyIds=1830472847398404097,1830472847398404098) or repeat the parameter. At least 1 and at most 100 ids, each a positive decimal Snowflake.
Response
200 · A JSON array of hydrated properties. The fields below describe one element. `customFieldValues` is absent — this endpoint does not load custom field values.
idstringSnowflake id of the property.
namestringThe name a property manager gave the property. Absent when the property was never named.
displayNamestringWhat to show in a list: the name if there is one, otherwise streetAddress1, otherwise the literal "Unnamed Property". Computed on every read.
addressobjectThe property's address. Absent when no address has been recorded.
portfolioIdstringThe portfolio this property sits in.
typeenum<string>What kind of building this is. A singleFamily or condo property, and a townHome with exactly one unit, is treated as a single-unit property elsewhere in the API.
totalFloorsintegerNumber of floors in the building, 1 to 200. Absent when it was never set.
unitCountintegerHow many units belong to the property, active and deactivated together. Maintained by MagicDoor as units are created and deleted; you cannot set it.
recentRentalApplicationsintegerHow many rental applications naming this property arrived in the recent window. Computed; you cannot set it.
activebooleanfalse once the property has been deactivated.
imageIdstringThe file behind the property's main photo. Absent when no photo has been set.
iconsstring[]Icon keys pinned to the property. Free-form strings.
magicTagsobjectFree-form labels on the property, as a map of string keys to string values. MagicDoor stores them as given and uses them to scope things like vendor bills. Absent when none are set.
imageobjectThe property's main photo, resolved from imageId. Absent when no photo has been set.
portfolioobjectThe portfolio this property sits in, expanded.
totalRentnumberComputed: the sum of currentRent across the property's active leases. Not stored — you cannot set it.
currentBalancenumberComputed: the sum of balance across the property's active leases. A positive figure means tenants owe money.
postedBalancenumberComputed: the sum of postedBalance across the property's active leases — the same total as currentBalance but counting only charges that have already been posted.
totalDepositnumberComputed: the sum of securityDepositPaid across the property's active leases.
occupiedUnitsintegerComputed: how many distinct units of this property have an active lease.
activeUnitsintegerComputed: how many of the property's units are active. Differs from unitCount, which also counts deactivated units.
emptyUnitsintegerComputed as activeUnits minus occupiedUnits.
ownersobject[]Who owns the property and in what share. Empty when no owner has been linked.
defaultUnitobjectThe property's only unit, returned when the property is a single-unit one — singleFamily, condo, or a townHome with exactly one unit. Absent otherwise.