get-all-copy

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

The tenants endpoint returns a list of all tenants in your AppFolio® account. This endpoint should respond immediately with your most recently cached data.

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.

---

visibilityselect

Tenant Visibility status to serve as filter.

Default Value:  

active

Possible Values:  

active

hidden

all

---

statusmulti

Tenant Status to serve as filter.

Default Value:  

current

notice

Possible Values:  

current

past

future

evict

notice

all

---

 

Returns

---

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