Skip to main content

Vendors

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

The Vendor Object#

Attributes

appfolioIdstring
Unique AppFolio ID for vendor.
Example:
"388"
companyNamestring
Company name of vendor.
Example:
"Paint & Hardware, Inc."
namestring
Company name of full name of vendor.
Example:
null
fullAddressstring
Full address.
Example:
"915 Paint Street Los Angeles, CA 90006"
phoneNumbersPhoneNumber[]
Phone numbers for vendor.
Example:
[{"label":"Office","phone":"(111) 111-1111"}]
emailstring
Email of vendor.
Example:
null

More Attributes

Expand All
âž•
address.streetstring
âž•
address.street2string
âž•
address.citystring
âž•
address.statestring
âž•
address.zipstring
âž•
defaultGLAccountstring
âž•
paymentTypestring
âž•
tagsstring[]
Show Additional 14 Attributes
The Vendor Object
{
"appfolioId": "388",
"companyName": "Paint & Hardware, Inc.",
"name": null,
"firstName": null,
"lastName": null,
"fullAddress": "915 Paint Street Los Angeles, CA 90006",
"address": {
"street": "915 Paint Street",
"street2": null,
"city": "Los Angeles",
"state": "CA",
"zip": "90006"
},
"phoneNumbers": [
{
"label": "Office",
"phone": "(111) 111-1111"
}
],
"email": null,
"defaultGLAccount": null,
"paymentType": "check",
"send1099": false,
"workersCompExpires": null,
"liabilityInsExpires": null,
"epaCertExpires": null,
"stateLicExpires": null,
"contractExpires": null,
"tags": [],
"enrolledInNetVendor": false,
"autoInsExpires": null,
"vendorTrades": null,
"doNotUseForWorkOrder": false,
"terms": null
}

Get All Vendors#

GET /v1/vendors

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

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

Parameters#

This endpoint requires no additional parameters.

Returns#

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

GET /v1/vendors
curl -X GET 'https://api.skywalkapi.com/v1/vendors' \
-H "X-API-Key: PUT_YOUR_API_KEY_HERE"
Response
{
"meta": {
"status": "ok",
"path": "/v1/vendors",
"query": {},
"count": 1,
"lastUpdated": 1610992228
},
"links": {
"next": "/v1/vendors?cursor=abcdefg"
},
"data": [
{
"appfolioId": "388",
"companyName": "Paint & Hardware, Inc.",
"name": null,
"firstName": null,
"lastName": null,
"fullAddress": "915 Paint Street Los Angeles, CA 90006",
"address": {
"street": "915 Paint Street",
"street2": null,
"city": "Los Angeles",
"state": "CA",
"zip": "90006"
},
"phoneNumbers": [
{
"label": "Office",
"phone": "(111) 111-1111"
}
],
"email": null,
"defaultGLAccount": null,
"paymentType": "check",
"send1099": false,
"workersCompExpires": null,
"liabilityInsExpires": null,
"epaCertExpires": null,
"stateLicExpires": null,
"contractExpires": null,
"tags": [],
"enrolledInNetVendor": false,
"autoInsExpires": null,
"vendorTrades": null,
"doNotUseForWorkOrder": false,
"terms": null
}
]
}