Request Details
A few things to note about how to create requests to the Skywalk API.
#
Request URL#
Base URLAll requests start with our base V1 URL.
API Root URL
#
AuthorizationAuthorization is done through the header key X-API-KEY
.
Authorization
#
Processing ModeSome 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:
Setting | Max Duration To First Data* | API Usage |
---|---|---|
default | 24 seconds | 1 |
longer | 120 seconds | 2 |
Note that longer processing will count towards additional API usage.
If the header is not set, the value default
is the default.
Processing Mode
#
Filters and SettingsAny filters are done through query parameters. If you want to pass in a list of values, repeat the query parameter.
Query Parameters