Lease renewals

List renewal offers

Returns a page of renewal offers across every lease in the company, with the leases, properties and units they belong to alongside. Filter by status to see only the ones still waiting on a tenant.

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

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
statusesenum<string>[]

Only offers in any of these states.

offeredsigningfinalizedrejectedretracted

Response

200 · A page of renewal offers.

itemsLeaseRenewalOffer[]

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.

chartOfAccountsChartOfAccount[]

Chart-of-account records referenced above.

leasesLease[]

The leases the offers are on.

propertiesProperty[]

The properties those leases are on.

unitsUnit[]

The units those leases are on.

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.

Offers and the standing policy are different things

A renewal offer is one proposal on one lease: a new end date and the rent changes that go with it. The automatic-renewal settings are a standing policy for a portfolio, a property, or the whole company, which MagicDoor uses to raise those offers for you. Changing the policy does not change offers that already exist. The two live under different endpoints — see Automatic renewals.