Skip to main content

Renewal Summary

NewBeta

RenewalSummary objects represent rows from the AppFolio® Renewal Summary report. Each row is a single lease whose new start date falls inside the report window, with previous vs. new rent, the dollar/percent change, term, and current renewal status.

The RenewalSummary Object​

Attributes

➖
property.appfolioIdinteger
AppFolio ID of the property.
Example:
456
➖
property.namestring
Name of the property.
Example:
"Sample Property"
➖
unit.appfolioIdinteger
AppFolio ID of the unit.
Example:
1085
➖
unit.namestring
Name of the unit.
Example:
"108"
➖
tenant.appfolioIdinteger
AppFolio ID of the tenant.
Example:
3461
➖
tenant.namestring
Name of the tenant.
Example:
"Brown, Whitney N."
leaseStartstring
New lease start date (MM/DD/YYYY).
Example:
"04/07/2026"
leaseEndstring
New lease end date (MM/DD/YYYY).
Example:
"06/06/2027"
previousLeaseStartstring
Previous lease start date (MM/DD/YYYY).
Example:
"01/07/2025"
previousLeaseEndstring
Previous lease end date (MM/DD/YYYY).
Example:
"04/06/2026"
previousRentstring
Rent amount from the previous lease.
Example:
"1,200.00"
rentstring
Rent amount for the renewed lease.
Example:
"1,363.00"
dollarDifferencestring
Dollar difference between renewed and previous rent.
Example:
"163.00"
percentDifferencestring
Percent difference between renewed and previous rent.
Example:
"13.58"
statusstring
Renewal status (e.g. Renewed, Did Not Renew).
Example:
"Renewed"
termstring
Lease term description (e.g. "12 months").
Example:
"14 months"
The RenewalSummary Object
{
  "property": {
    "appfolioId": 456,
    "name": "Sample Property"
  },
  "unit": {
    "appfolioId": 1085,
    "name": "108"
  },
  "tenant": {
    "appfolioId": 3461,
    "name": "Brown, Whitney N."
  },
  "leaseStart": "04/07/2026",
  "leaseEnd": "06/06/2027",
  "previousLeaseStart": "01/07/2025",
  "previousLeaseEnd": "04/06/2026",
  "previousRent": "1,200.00",
  "rent": "1,363.00",
  "dollarDifference": "163.00",
  "percentDifference": "13.58",
  "status": "Renewed",
  "term": "14 months"
}

Get Renewal Summary​

GET /v1/renewal-summary

Follows: Authentication • Caching • Polling • List Response Format • Scheduled Job

The renewal-summary endpoint returns the Renewal Summary report for your AppFolio® portfolio. Each row represents a single lease whose new start date falls inside the report window, with previous vs. new rent, dollar and percent change, term length, and current renewal status. The window defaults to this and the next six months; pass dateFrom / dateTo (MM/YYYY) for a custom range or dateRange for a relative preset. Filter by renewal state with the status parameter (All, Renewed, Not Renewed, Month To Month, Pending, Canceled By User).

Parameters​

propertyIdselect
AppFolio ID of a Property to serve as a filter.
propertyGroupIdselect
AppFolio ID of a Property Group to serve as a filter.
ownerIdselect
AppFolio ID of an Owner to serve as a filter.
dateRangeselect
New lease start Range for report.
Default Value:  
this_and_next_6_months
Possible Values:  
this_month
this_quarter
this_year
this_year_to_month
last_month
last_quarter
last_year
trailing_3_months
trailing_6_months
trailing_12_months
rolling_12_months
this_and_next_3_months
this_and_next_6_months
dateFromdate_month
New lease start to given in MM/YYYY (e.g. 01/2021)
dateTodate_month
New lease start to given in MM/YYYY (e.g. 01/2021)
statusselect
Filter by renewal status. Default: All. Possible values: All, Renewed, Not Renewed, Month To Month, Pending, Canceled By User
Default Value:  
All
Possible Values:  
All
Renewed
Not Renewed
Month To Month
Pending
Canceled By User
 

Returns​

The standard List Response Format with a data property containing an array of RenewalSummary objects.

GET /v1/renewal-summary
curl -X GET 'https://api.skywalkapi.com/v1/renewal-summary' \ 
  -H "X-API-Key: PUT_YOUR_API_KEY_HERE"
Response
{
  "meta": {
    "status": "ok",
    "path": "/v1/renewal-summary",
    "query": {},
    "count": 1,
    "lastUpdated": 1776988800
  },
  "links": {
    "next": "/v1/renewal-summary?cursor=abcdefg"
  },
  "data": [
    {
      "property": {
        "appfolioId": 456,
        "name": "Sample Property"
      },
      "unit": {
        "appfolioId": 1085,
        "name": "108"
      },
      "tenant": {
        "appfolioId": 3461,
        "name": "Brown, Whitney N."
      },
      "leaseStart": "04/07/2026",
      "leaseEnd": "06/06/2027",
      "previousLeaseStart": "01/07/2025",
      "previousLeaseEnd": "04/06/2026",
      "previousRent": "1,200.00",
      "rent": "1,363.00",
      "dollarDifference": "163.00",
      "percentDifference": "13.58",
      "status": "Renewed",
      "term": "14 months"
    }
  ]
}