Skip to main content

Owners

Owner objects represent top-level owner data from AppFolio®. Skywalk API allows you to obtain the following owner attributes from AppFolio®.

The Owner Object#

Attributes

appfolioIdstring
Unique AppFolio ID for this owner.
Example:
"14"
namestring
Display name of owner.
Example:
"Johnson, Johnny"
firstNamestring
First name of owner.
Example:
"Johnny"
lastNamestring
Last name of owner.
Example:
"Johnson"
emailAddressstring
Email addresses for the owner.
Example:
"johnny@jj.com"
propertyIdsstring[]
Property IDs belonging to owner.
Example:
["11","15","17"]

More Attributes

Expand All
âž•
phoneNumbersPhoneNumber[]
âž•
fullAddressstring
âž•
address.streetstring
âž•
address.street2string
âž•
address.citystring
âž•
address.statestring
âž•
address.zipstring
âž•
address.countrystring
âž•
notesForOwnerstring
âž•
ownerPacketReportsstring[]
âž•
sendOwnerPacketsByEmailboolean
âž•
lastPacketSentstring
âž•
alternativePayeestring
âž•
paymentTypestring
âž•
lastPaymentDatestring
âž•
holdPaymentsboolean
Show Additional 2 Attributes
The Owner Object
{
"appfolioId": "14",
"name": "Johnson, Johnny",
"firstName": "Johnny",
"lastName": "Johnson",
"emailAddress": "johnny@jj.com",
"phoneNumbers": [
{
"label": "Mobile",
"phone": "(555) 123-4567"
}
],
"fullAddress": "1375 E Buena Vista Dr. Orlando, FL 32830",
"address": {
"street": "1375 E Buena Vista Dr.",
"street2": null,
"city": "Orlando",
"state": "FL",
"zip": "32830",
"country": "United States"
},
"propertyIds": [
"11",
"15",
"17"
],
"tags": null,
"notesForOwner": null,
"ownerPacketReports": [
"Aged Receivable Detail",
"Annual Budget - Comparative",
"Balance Sheet",
"Check Register Detail (Enhanced)",
"General Ledger",
"Income Register",
"Owner Statement (Enhanced)",
"Rent Roll",
"Resident Financial Activity"
],
"sendOwnerPacketsByEmail": true,
"lastPacketSent": "03/14/2021",
"alternativePayee": "Johnny and Jessica Johnson",
"paymentType": "check",
"lastPaymentDate": "03/16/2021",
"holdPayments": false
}

Get All Owners#

GET /v1/owners

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

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

Parameters#

ownerVisibilityselect
Owner Visibility status to serve as filter.
Default Value:  
active
Possible Values:  
active
hidden
all
propertyVisibilityselect
Property Visibility status to serve as filter.
Default Value:  
active
Possible Values:  
active
hidden
all
 

Returns#

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

GET /v1/owners
curl -X GET 'https://api.skywalkapi.com/v1/owners' \
-H "X-API-Key: PUT_YOUR_API_KEY_HERE"
Response
{
"meta": {
"status": "ok",
"path": "/v1/owners",
"query": {},
"count": 1,
"lastUpdated": 1610992228
},
"links": {
"next": "/v1/owners?cursor=abcdefg"
},
"data": [
{
"appfolioId": "14",
"name": "Johnson, Johnny",
"firstName": "Johnny",
"lastName": "Johnson",
"emailAddress": "johnny@jj.com",
"phoneNumbers": [
{
"label": "Mobile",
"phone": "(555) 123-4567"
}
],
"fullAddress": "1375 E Buena Vista Dr. Orlando, FL 32830",
"address": {
"street": "1375 E Buena Vista Dr.",
"street2": null,
"city": "Orlando",
"state": "FL",
"zip": "32830",
"country": "United States"
},
"propertyIds": [
"11",
"15",
"17"
],
"tags": null,
"notesForOwner": null,
"ownerPacketReports": [
"Aged Receivable Detail",
"Annual Budget - Comparative",
"Balance Sheet",
"Check Register Detail (Enhanced)",
"General Ledger",
"Income Register",
"Owner Statement (Enhanced)",
"Rent Roll",
"Resident Financial Activity"
],
"sendOwnerPacketsByEmail": true,
"lastPacketSent": "03/14/2021",
"alternativePayee": "Johnny and Jessica Johnson",
"paymentType": "check",
"lastPaymentDate": "03/16/2021",
"holdPayments": false
}
]
}