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.
Authorization
AuthorizationstringrequiredPath parameters
leaseIdstringrequiredThe lease whose offers you want. A Snowflake id, sent as a decimal string.
Query parameters
pageintegerWhich page to return. Starts at 1.
pageSizeintegerHow many rows per page, between 1 and 100.
statusesenum<string>[]Only offers in any of these states.
Response
200 · A page of renewal offers on this lease.
itemsLeaseRenewalOffer[]The rows on this page.
currentPageintegerThe page you asked for. Pages start at 1.
totalPagesintegerHow many pages exist at this page size.
pageSizeintegerHow many rows a page holds.
totalCountintegerHow 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.
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.