MagicDoorAPI
SupportOpen MagicDoor
Reports

Tenant directory report

Lists every tenant with the leases they are on and the unit and property each lease is for. One row is one tenant.

GET
https://api.portal.magicdoor.com/company-app/reports/tenant-directory

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.

Query parameters

portfolioIdsstring[]

Narrow the report to these portfolios. Repeat the parameter once per id. An id that does not exist returns 404.

propertyIdsstring[]

Narrow the report to these properties. Repeat the parameter once per id. An id that does not exist returns 404.

ownerIdsstring[]

Narrow the report to properties these owners have a stake in. Repeat the parameter once per id. An id that does not exist returns 404.

includeNoActiveLeaseboolean

Whether to include tenants who are not on any active lease right now.

default: false

Response

200 · Every tenant and their leases.

itemsobject[]

One entry per tenant.

401 · The access token is missing, expired, or not valid for this company.

404 · A portfolio, property or owner id in the query does not exist in the caller's company.

The lease object here is not a full lease

leases[].lease holds only the tenant's own place on the lease: the tenant id and the move dates. It is not the lease record the other reports return, so it carries no rent, balance or term.