Properties

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.

GET
https://api.portal.magicdoor.com/company-app/properties/{propertyId}/overview

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

propertyIdstringrequired

Snowflake id of the property, as a decimal string.

example: 1830472847398404097

Response

200 · The property and everything hanging off it.

propertyobject

The property itself, without the money rollups the properties endpoints add.

summaryobject

Occupancy and money roll-ups for this property. All computed.

revenueobject

The 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.

expiringLeaseCountsobject

How the property's leases are spread by how soon they end.

cacheDatestring · date-time

When 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 numbers may lag

The summary is computed from a cache. cacheDate tells you when it was last recomputed; anything that changed after that is not reflected yet.