MagicDoorAPI
SupportOpen MagicDoor
Leases

List leases with a move-out date

Returns a page of leases that have a move-out date set, so you can plan turnovers. Filter by the move-out date range to get a single month's worth.

GET
https://api.portal.magicdoor.com/company-app/leases/move-outs

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

pageinteger

Which page to return. Starts at 1.

default: 1example: 1
pageSizeinteger

How many rows per page, between 1 and 100.

default: 50example: 50
portfolioIdsstring[]

Only leases in any of these portfolios.

propertyIdsstring[]

Only leases on any of these properties.

unitIdsstring[]

Only leases on any of these units.

moveOutDateRange.startstring · date-time

Only leases moving out on or after this instant.

moveOutDateRange.endstring · date-time

Only leases moving out on or before this instant.

Response

200 · A page of leases with a move-out date.

itemsHydratedLease[]

The rows on this page.

currentPageinteger

The page you asked for. Pages start at 1.

totalPagesinteger

How many pages exist at this page size.

pageSizeinteger

How many rows a page holds.

totalCountinteger

How many rows match in total, across all pages.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

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