get-all-copy

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

The lease history endpoint returns a list of leases in your AppFolio® account.

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

Date 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

Date to given in MM/YYYY (e.g. 01/2021)

---

dateTodate_month

Date to given in MM/YYYY (e.g. 01/2021)

---

leaseStatusselect

Filter leases for a specific status.

Default: all.

Possible Values: all, Completed, Did Not Renew, Month To Month, Pending, Status Cannot Be Determined

Default Value:  

all

Possible Values:  

all

Completed

Did Not Renew

Month To Month

Pending

Status Cannot Be Determined

---

unitVisibilityselect

Filter by unit visibility.

Default: all.

Possible Values: all, active, hidden

Default Value:  

all

Possible Values:  

all

active

hidden

---

tenantVisibilityselect

Filter by tenant visibility.

Default: all.

Possible Values: all, active, hidden

Default Value:  

all

Possible Values:  

all

active

hidden

---

filterLeaseByselect

Filter leases by date.

Default: Lease Start Date.

Possible Values: Lease Start Date, Lease Countersigned Date

Default Value:  

Lease Start Date

Possible Values:  

Lease Start Date

Lease Countersigned Date

---

 

Returns

---

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