Skip to main content

Guest Cards

GuestCard objects represent guest cards from AppFolio®. Skywalk API allows you to obtain the following guest card attributes from AppFolio®.

The GuestCard Object#

Attributes

tenantIDstring
ID of tenant associated with this guest card
Example:
null
guestCardIdstring
Unique ID of this guest card
Example:
1234
propertyIdstring
ID of property associated with this guest card
Example:
"7"
unitIdstring
ID of unit associated with this guest card
Example:
null
statusstring
Status of the guest card
Example:
"Active"
sourcestring
Source of the guest card
Example:
"Driving By"
namestring
Name of prospect
Example:
"Norstrom, Gary"
emailAddressstring
Email address of prospect
Example:
"somelead@email.com"
phoneNumberstring
Phone number of this prospect
Example:
"(111) 111-1111"
receivedstring
Date guest card received
Example:
"01/20/2023 at 10:00 PM"

More Attributes

Expand All
âž•
bedBathPreferencestring
âž•
creditScorestring
âž•
lastActivityDatestring
âž•
lastActivityTypestring
âž•
leadTypestring
âž•
maxRentstring
âž•
monthlyIncomestring
âž•
moveInPreferencestring
âž•
petPreferencestring
Show Additional 8 Attributes
The GuestCard Object
{
"assignedUser": null,
"assignedUserID": null,
"bedBathPreference": "2 / 2.00",
"creditScore": null,
"emailAddress": "somelead@email.com",
"lastActivityDate": "01/29/2023",
"lastActivityType": "Additional Inquiry Received",
"leadType": "Free",
"lisaForecast": "--",
"lisaLead": "No",
"maxRent": null,
"monthlyIncome": null,
"moveInPreference": "02/01/2023",
"name": "Norstrom, Gary",
"notes": null,
"petPreference": null,
"phoneNumber": "(111) 111-1111",
"property": "Warm Weather Apartments - 1234 Warm Weather Rd., CA 90001",
"propertyId": "7",
"propertyName": "Warm Weather Apartments",
"received": "01/20/2023 at 10:00 PM",
"source": "Driving By",
"status": "Active",
"tenantID": null,
"unit": null,
"guestCardId": 1234,
"unitId": null
}

Get All Guest Cards#

GET /v1/guest-cards

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.

GET /v1/guest-cards
curl -X GET 'https://api.skywalkapi.com/v1/guest-cards' \
-H "X-API-Key: PUT_YOUR_API_KEY_HERE"
Response
{
"meta": {
"status": "ok",
"path": "/v1/guest-cards",
"query": {},
"count": 1,
"lastUpdated": 1610992228
},
"links": {
"next": "/v1/guest-cards?cursor=abcdefg"
},
"data": [
{
"assignedUser": null,
"assignedUserID": null,
"bedBathPreference": "2 / 2.00",
"creditScore": null,
"emailAddress": "somelead@email.com",
"lastActivityDate": "01/29/2023",
"lastActivityType": "Additional Inquiry Received",
"leadType": "Free",
"lisaForecast": "--",
"lisaLead": "No",
"maxRent": null,
"monthlyIncome": null,
"moveInPreference": "02/01/2023",
"name": "Norstrom, Gary",
"notes": null,
"petPreference": null,
"phoneNumber": "(111) 111-1111",
"property": "Warm Weather Apartments - 1234 Warm Weather Rd., CA 90001",
"propertyId": "7",
"propertyName": "Warm Weather Apartments",
"received": "01/20/2023 at 10:00 PM",
"source": "Driving By",
"status": "Active",
"tenantID": null,
"unit": null,
"guestCardId": 1234,
"unitId": null
}
]
}