Skip to main content

get-all-copy

Follows: AuthenticationCachingPollingList Response FormatScheduled Job

The showings endpoint returns the property showings in your AppFolio® account, filtered by date range, status, property, and assigned user. Filter values mirror the dropdowns on the AppFolio Showings report: status accepts all, scheduled, confirmed, completed, canceled, or no_show; propertyVisibility accepts active, active_and_inactive, or inactive. If you omit the date filter, we default to this_month_to_date so new accounts see the current month's showings out-of-the-box.

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
Showing 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
Showing Date to given in MM/DD/YYYY (e.g. 01/31/2021)

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

statusselect
Filter showings for a specific status. Default: all.
Default Value:  
all
Possible Values:  
all
scheduled
confirmed
completed
canceled
no_show

assignedUserstring
Filter showings for a specific assigned user. Accepts the AppFolio user display name (e.g. "Jane Manager") or AppFolio user ID. Default: All.

propertyVisibilityselect
Filter by property visibility. Default: active.
Default Value:  
active
Possible Values:  
active
active_and_inactive
inactive

sortOrderselect
Sort order for ShowingTime. Default: desc.
Default Value:  
desc
Possible Values:  
desc
asc

 

Returns


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