List expiring leases
Returns a page of leases whose fixed term is coming to an end, so you can decide what to offer as a renewal. Each row carries its expiringStatus, which says how close the end date is.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Query parameters
pageintegerWhich page to return. Starts at 1.
default: 1example: 1
pageSizeintegerHow 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.
Response
200 · A page of expiring leases.
itemsHydratedLease[]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.