Skip to main content

Request Details

A few things to note about how to create requests to the Skywalk API.

Request URL#

Base URL#

All requests start with our base V1 URL.

API Root URL
https://api.skywalkapi.com/v1/

Authorization#

Authorization is done through the header key X-API-KEY.

Authorization
X-API-KEY=1288291.....

Processing Mode#

Some endpoints may take longer than usual based on the amount of data and setup of each Appfolio account. To account for this, you may configure the X-API-PROCESSING-MODE header to allow for longer processing.

The following is the supported values and how they impact timing and API usage:

SettingMax Duration To First Data*API Usage
default24 seconds1
longer120 seconds2

Note that longer processing will count towards additional API usage.

If the header is not set, the value default is the default.

* Note that Max Duration To First Data is not the max duration for the endpoint or for total processing. This represents the maximum time until first data is processed by Skywalk API behind the scene. Actual max duration of getting data back may take significantly longer.
Processing Mode
X-API-PROCESSING-MODE=longer

Filters and Settings#

Any filters are done through query parameters. If you want to pass in a list of values, repeat the query parameter.

Query Parameters
?propertyId=123&status=current&status=past