Lease move-outs

List move-out requests

Returns every move-out request on the lease, including ones already accepted or turned down, with the tenant who asked and the date they want to leave.

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

Path parameters

leaseIdstringrequired

The lease whose move-out requests you want. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Response

200 · The move-out requests on the lease.

idstring

Id of the move-out request. A Snowflake id, sent as a decimal string.

leaseIdstring

The lease the request is on. A Snowflake id, sent as a decimal string.

statusenum<string>

Where the request stands: requested while it is waiting on the company, approved once accepted, rejected once turned down, retracted if the tenant withdrew it.

requestedrejectedapprovedretracted
moveOutDatestring · date-time

The date the tenant wants to leave, in the company's timezone.

reasonstring

Why the tenant is leaving, when they gave a reason.

createdDatestring · date-time

When the request was made, in the company's timezone.

tenantobject

The tenant who asked. Absent when the company set the date itself.

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

404 · No lease matched the id, or it belongs to another company.