get-all-copy

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

The gross-potential-rent endpoint returns the Gross Potential Rent report for your AppFolio® portfolio. Each row represents a single unit for the selected month, showing scheduled rent, vacancy and concession losses, and the resulting net rent income. Use the month parameter (MM/YYYY) to select the reporting month; it defaults to the current month. The accounting parameter accepts cash (default) or accrual.

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.

---

monthstring

Month of the report (1-12).

---

yearstring

Year of the report (e.g. 2026).

---

propertyVisibilityselect

Filter by property visibility. Default: active.

Default Value:  

active

Possible Values:  

active

active_and_inactive

inactive

---

accountingselect

Accounting Basis.

Default: cash.

Possible Values: cash, accrual

Default Value:  

cash

Possible Values:  

cash

accrual

---

 

Returns

---

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