Lease renewals

List a lease's renewal offers

Returns a page of renewal offers on one lease, newest work first, together with the lease, property and unit they belong to.

GET
https://api.portal.magicdoor.com/company-app/leases/{leaseId}/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.

Path parameters

leaseIdstringrequired

The lease whose offers you want. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

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 on this lease.

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 lease the offers are on.

propertiesProperty[]

The property the lease is on.

unitsUnit[]

The unit the lease is 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.

404 · No lease matched the id, or it belongs to another 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.