get-all-copy

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

The guest card endpoint returns a list of all guest cards 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.

---

dateRangeselect

Date 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

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

---

dateTodate

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

---

leadStatusselect

Filter guest cards for a specific status.

Default Value:  

all

Possible Values:  

all

prequalified

active

waitlisted

application_completed

inactive

cold

---

leadTypeselect

Filter guest cards for a specific type.

Default: all.

Possible Values: all, Free, Premium, Hang Up, Refunded

Default Value:  

all

Possible Values:  

all

Free

Premium

Hang Up

Refunded

---

 

Returns

---

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