Skip to main content

Leasing Summary

NewBeta

LeasingSummary objects represent rows from the AppFolio® Leasing Summary report. Each row aggregates per-unit-type counts for inquiries, showings, applications, move-ins, move-outs, and leases executed over the selected report period. Portfolio-level totals are exposed in meta.summary.

The LeasingSummary Object

Attributes


unitTypestring
Unit-type label as shown in AppFolio (e.g. "The Kokomo | 2B").
Example:
"The Kokomo | 2B"

unitCountinteger
Total number of units of this type.
Example:
11

modelUnitCountinteger
Number of model units of this type.
Example:
0

inquiriesReceivedinteger
Number of inquiries received during the reporting period.
Example:
0

showingsCompletedinteger
Number of showings completed during the reporting period.
Example:
0

applicationsReceivedinteger
Number of applications received during the reporting period.
Example:
0

moveInsinteger
Number of move-ins during the reporting period.
Example:
1

moveOutsinteger
Number of move-outs during the reporting period.
Example:
0

leasedinteger
Number of leases executed during the reporting period. AppFolio defines "Leased" as the count of lease documents that were sent and signed (new leases or renewals fully executed) within the report window.
Example:
0

The LeasingSummary Object
{
"unitType": "The Kokomo | 2B",
"unitCount": 11,
"modelUnitCount": 0,
"inquiriesReceived": 0,
"showingsCompleted": 0,
"applicationsReceived": 0,
"moveIns": 1,
"moveOuts": 0,
"leased": 0
}

Get Leasing Summary

GET /v1/leasing-summary

Follows: AuthenticationCachingPollingList Response FormatScheduled Job

The leasing-summary endpoint returns the Leasing Summary report for your AppFolio® portfolio. Each row aggregates per-unit-type counts of inquiries, showings, applications, move-ins, move-outs, and leases executed for the requested period. Portfolio-level totals (across every row in the response) are exposed in meta.summary. Use dateFrom / dateTo (MM/YYYY) for a custom window, or pass dateRange for a relative preset such as this-month-to-day.

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
Report period Range for report.
Default Value:  
this_month_to_date
Possible Values:  
today
this_week
this_week_to_date
this_month
this_month_to_date
this_quarter
this_quarter_to_date
this_year_to_date
last_year
last_year_to_date
yesterday
last_week
last_week_to_date
last_month
last_month_to_date
last_quarter
last_quarter_to_date
last_7_days
last_30_days
last_60_days
last_90_days
trailing_12_months
next_7_days
next_30_days
next_60_days
next_90_days
next_week
next_month
next_quarter
until_1_week_ago
until_1_month_ago
all_time

dateFromdate
Report period to given in MM/DD/YYYY (e.g. 01/31/2021)

dateTodate
Report period to given in MM/DD/YYYY (e.g. 01/31/2021)

 

Returns


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

GET /v1/leasing-summary?dateFrom=04/01/2026&dateTo=04/30/2026
curl -X GET 'https://api.skywalkapi.com/v1/leasing-summary?dateFrom=04/01/2026&dateTo=04/30/2026' \
-H "X-API-Key: PUT_YOUR_API_KEY_HERE"
Response
{
"meta": {
"status": "ok",
"path": "/v1/leasing-summary",
"query": {
"dateFrom": "04/01/2026",
"dateTo": "04/30/2026"
},
"count": 2,
"lastUpdated": 1776988800,
"summary": {
"unitCount": 19,
"modelUnitCount": 0,
"inquiriesReceived": 3,
"showingsCompleted": 0,
"applicationsReceived": 3,
"moveIns": 2,
"moveOuts": 1,
"leased": 2
}
},
"links": {
"next": "/v1/leasing-summary?cursor=abcdefg"
},
"data": [
{
"unitType": "The Kokomo | 2B",
"unitCount": 11,
"modelUnitCount": 0,
"inquiriesReceived": 0,
"showingsCompleted": 0,
"applicationsReceived": 0,
"moveIns": 1,
"moveOuts": 0,
"leased": 0
},
{
"unitType": "The Kokomo | 1B",
"unitCount": 8,
"modelUnitCount": 0,
"inquiriesReceived": 3,
"showingsCompleted": 0,
"applicationsReceived": 3,
"moveIns": 1,
"moveOuts": 1,
"leased": 2
}
]
}