get-all-copy

Follows: Authentication • Caching • Polling • List Response Format • Scheduled 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.