> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/appfolio.md).

# AppFolio

Connect to AppFolio property management software to access properties, tenants, leases, and financial data.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| AppFolio  | Credentials    |

#### AppFolio

Connect to AppFolio Data API to access property management data including properties, tenants, leases, and financial information.

**Set up in AppFolio**

1. Sign in to AppFolio as a System Administrator (Data API access requires the AppFolio Plus or Max plan).
2. Click your name in the top-right corner and open **General Settings → Manage API Settings**.
3. Click **Generate New Credentials** and copy the **Client ID** and **Client Secret** (regenerating later invalidates the previous credentials).

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **AppFolio**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                       |
| ------------- | -------- | ----------------------------------------------------------------------------------- |
| Client ID     | Yes      | Your AppFolio Client ID from Account Settings > Manage API settings.                |
| Client Secret | Yes      | Your AppFolio Client Secret from Account Settings > Manage API settings.            |
| Developer ID  | Yes      | Your AppFolio Developer ID provided by AppFolio for API access.                     |
| API Domain    | Yes      | Your AppFolio company subdomain (e.g., 'xyzpractice' for xyzpractice.appfolio.com). |

**Provider documentation:** [Setup reference](https://www.appfolio.com/stack/partners/api).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **AppFolio** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Get Owners

Retrieve and search property owners from AppFolio

**Inputs**

| Field               | Type    | Required | Description                                                                             |
| ------------------- | ------- | -------- | --------------------------------------------------------------------------------------- |
| Search Term         | string  | No       | Search for owners by name, email, or company name (client-side filtering).              |
| Limit               | integer | No       | Maximum number of owners to return (optional).                                          |
| Include Companies   | boolean | No       | Whether to include company owners in results. Default: true.                            |
| Include Individuals | boolean | No       | Whether to include individual owners in results. Default: true.                         |
| Updated Since       | string  | No       | Only return owners updated since this date (YYYY-MM-DD format), defaults to 2024-01-01. |

**Outputs**

| Field       | Type    | Description                             |
| ----------- | ------- | --------------------------------------- |
| Owners      | object  | List of owners retrieved from AppFolio. |
| Total Count | integer | Total number of owners found.           |
| Success     | boolean | Whether the request was successful.     |

#### Get Properties

Retrieve and search properties from AppFolio

**Inputs**

| Field         | Type    | Required | Description                                                                                                               |
| ------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
| Search Term   | string  | No       | Search for properties by name, address, or other criteria.                                                                |
| Limit         | integer | No       | Maximum number of properties to return (optional).                                                                        |
| Property ID   | string  | No       | Get a specific property by its ID.                                                                                        |
| Updated Since | string  | No       | Only return properties updated since this date (YYYY-MM-DD format). Optional - defaults to last 30 days if not specified. |

**Outputs**

| Field       | Type    | Description                                 |
| ----------- | ------- | ------------------------------------------- |
| Properties  | object  | List of properties retrieved from AppFolio. |
| Total Count | integer | Total number of properties found.           |
| Success     | boolean | Whether the request was successful.         |

#### Get Vendor Details

Get detailed information for a specific vendor from AppFolio

**Inputs**

| Field     | Type   | Required | Description                      |
| --------- | ------ | -------- | -------------------------------- |
| Vendor ID | string | Yes      | Get a specific vendor by its ID. |

**Outputs**

| Field   | Type    | Description                             |
| ------- | ------- | --------------------------------------- |
| Vendor  | object  | Vendor details retrieved from AppFolio. |
| Success | boolean | Whether the request was successful.     |

#### Get Work Orders

Retrieve and search work orders from AppFolio

**Inputs**

| Field           | Type    | Required | Description                                              |
| --------------- | ------- | -------- | -------------------------------------------------------- |
| Work Order UUID | string  | No       | Get a specific work order by its UUID.                   |
| Property UUID   | string  | No       | Filter work orders by property ID.                       |
| Status          | string  | No       | Filter work orders by status.                            |
| Priority        | string  | No       | Filter work orders by priority.                          |
| Vendor UUID     | string  | No       | Filter work orders by vendor ID.                         |
| Created From    | string  | No       | Filter work orders created from this date (YYYY-MM-DD).  |
| Created To      | string  | No       | Filter work orders created until this date (YYYY-MM-DD). |
| Updated Since   | string  | No       | Filter work orders updated since this date (YYYY-MM-DD). |
| Limit           | integer | No       | Maximum number of work orders to return (optional).      |

**Outputs**

| Field       | Type    | Description                                  |
| ----------- | ------- | -------------------------------------------- |
| Work Orders | object  | List of work orders retrieved from AppFolio. |
| Total Count | integer | Total number of work orders found.           |
| Success     | boolean | Whether the request was successful.          |

#### Create Owner

Create a new owner in AppFolio

**Inputs**

| Field          | Type   | Required | Description                                     |
| -------------- | ------ | -------- | ----------------------------------------------- |
| First Name     | string | Yes      | Owner's first name.                             |
| Last Name      | string | Yes      | Owner's last name.                              |
| Email          | string | No       | Owner's email address (optional).               |
| Phone Number   | string | No       | Owner's phone number (optional).                |
| Company Name   | string | No       | Company name if owner is a business (optional). |
| Address Line 1 | string | No       | Owner's street address (optional).              |
| City           | string | No       | Owner's city (optional).                        |
| State          | string | No       | Owner's state (optional).                       |
| ZIP Code       | string | No       | Owner's ZIP code (optional).                    |

**Outputs**

| Field      | Type    | Description                                              |
| ---------- | ------- | -------------------------------------------------------- |
| Owner ID   | string  | ID of the newly created owner.                           |
| Success    | boolean | Whether the owner creation was successful.               |
| Message    | string  | Success or error message.                                |
| Owner Link | string  | Direct link to view the newly created owner in AppFolio. |

#### Create Work Order

Create a comprehensive work order in AppFolio with all available options

**Inputs**

| Field                        | Type     | Required | Description                                                                                 |
| ---------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------- |
| Property ID (UUID)           | string   | No       | UUID of the property (required if not using unit/occupancy/inspection).                     |
| Unit ID                      | string   | No       | UUID of the unit.                                                                           |
| Occupancy ID                 | string   | No       | UUID of the occupancy.                                                                      |
| Inspection ID                | string   | No       | UUID of the inspection.                                                                     |
| Job Description              | string   | Yes      | A brief description of the work order to be performed.                                      |
| Description                  | string   | No       | Top-level description for grouping work orders.                                             |
| Status                       | string   | No       | Status: Assigned, Canceled, Completed, New, Scheduled, Waiting, Work Completed.             |
| Priority                     | string   | No       | Priority level: Urgent, Normal, or Low.                                                     |
| Vendor ID                    | string   | No       | UUID of the vendor (leave empty if management company is vendor).                           |
| Vendor Trade                 | string   | No       | Type of service (e.g., Plumbing, Electrical, HVAC).                                         |
| Management Company as Vendor | boolean  | No       | Check if management company is the vendor.                                                  |
| Assigned Users               | string   | No       | User UUID(s) assigned to work order (comma-separated for multiple).                         |
| Scheduled Start              | string   | No       | Scheduled start time (ISO 8601 format).                                                     |
| Scheduled End                | string   | No       | Scheduled end time (ISO 8601 format).                                                       |
| Canceled On                  | string   | No       | Date the work order was canceled (YYYY-MM-DD).                                              |
| Completed On                 | string   | No       | Date the work order was completed (YYYY-MM-DD).                                             |
| Work Completed On            | string   | No       | Date the actual work was completed (YYYY-MM-DD).                                            |
| Permission to Enter          | string   | No       | Permission to enter (true/false or text description).                                       |
| Unit Turn Category           | string   | No       | Category for unit turn work order (requires unit\_id or occupancy\_id).                     |
| Billable Items (JSON)        | textarea | No       | JSON array of billable items with description, gl\_account\_id, quantity, rate.             |
| Labor Items (JSON)           | textarea | No       | JSON array of labor items with date, description, hours\_worked, hours\_billable, user\_id. |

**Outputs**

| Field           | Type    | Description                                     |
| --------------- | ------- | ----------------------------------------------- |
| Work Order ID   | string  | ID of the newly created work order.             |
| Work Order Link | string  | Link to the work order in AppFolio.             |
| Success         | boolean | Whether the work order creation was successful. |
| Message         | string  | Success or error message.                       |

#### Update Work Order

Update scheduled date and status on an AppFolio work order.

**Inputs**

| Field                         | Type            | Required | Description                                                                                                                                                             |
| ----------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Work Order UUID               | string          | Yes      | UUID of the work order to update.                                                                                                                                       |
| Status                        | select (string) | Yes      | Work order status. Either 'Scheduled' or 'Work Done'. Available values: Scheduled, Work Done.                                                                           |
| Scheduled Date                | string          | No       | Date for the scheduled work order in format YYYY-MM-DD. Required if status is 'Scheduled'.                                                                              |
| Start Time                    | string          | No       | Start time for the scheduled work order in format HH:MM AM/PM. Required if status is 'Scheduled'.                                                                       |
| Duration / Appointment Window | string          | No       | Duration of the appointment window (up to 6 hours). Must be one of: 30 Minutes, 1 Hour, 2 Hours, 3 Hours, 4 Hours, 5 Hours, 6 Hours. Required if status is 'Scheduled'. |
| Work Done On                  | string          | No       | Date the work was done in format YYYY-MM-DD. Required if status is 'Work Done'.                                                                                         |

**Outputs**

| Field         | Type    | Description                               |
| ------------- | ------- | ----------------------------------------- |
| Work Order ID | string  | The ID of the updated work order.         |
| Success       | boolean | Whether the update was successful.        |
| Message       | string  | Status message from the update operation. |

#### Create Properties

Create properties in AppFolio property management system with comprehensive details

**Inputs**

| Field                            | Type    | Required | Description                                                                                                 |
| -------------------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| Property Name                    | string  | Yes      | Name of the property to create.                                                                             |
| Reference ID                     | string  | Yes      | Unique reference identifier for this property.                                                              |
| Property Type                    | string  | Yes      | Type of property being created (Single-Family, Multi-Family, Self-Storage, Student-Housing, or Commercial). |
| Street Address                   | string  | Yes      | Primary street address of the property.                                                                     |
| Address Line 2                   | string  | No       | Secondary address line (optional).                                                                          |
| City                             | string  | Yes      | City where the property is located.                                                                         |
| State                            | string  | Yes      | State abbreviation (2 letters).                                                                             |
| ZIP Code                         | string  | Yes      | 5-digit ZIP code.                                                                                           |
| Operating Bank Account Name      | string  | Yes      | Name of the bank account for property operating expenses and income.                                        |
| Operating Bank Name              | string  | Yes      | Name of the bank for operating account.                                                                     |
| Escrow Bank Account Name         | string  | Yes      | Name of the bank account for escrow funds (security deposits, etc.).                                        |
| Escrow Bank Name                 | string  | Yes      | Name of the bank for escrow account.                                                                        |
| Admin Fee                        | number  | No       | Admin fee amount for the property.                                                                          |
| NSF Fee                          | number  | No       | Non-sufficient funds (NSF) fee amount.                                                                      |
| Amenities                        | string  | No       | Comma-separated list of property amenities.                                                                 |
| Cats Allowed                     | string  | No       | Cat policy (Yes, No, or leave empty).                                                                       |
| Dogs Allowed                     | string  | No       | Dog policy (Large & Small, Small Only, No).                                                                 |
| Property Class                   | string  | No       | Property quality classification (A+, A, A-, B+, B, B-, C+, C, C-).                                          |
| Year Built                       | integer | No       | Year the property was constructed.                                                                          |
| Insurance Expiration Date        | string  | No       | Date when property insurance expires (YYYY-MM-DD).                                                          |
| Maintenance Limit                | string  | No       | Dollar amount limit for maintenance (as string with decimals).                                              |
| Maintenance Notes                | string  | No       | Notes about property maintenance.                                                                           |
| Management Start Date            | string  | No       | Date when property management began (ISO format).                                                           |
| Management End Date              | string  | No       | Date when property management ended (ISO format).                                                           |
| Management End Reason            | string  | No       | Reason for ending management.                                                                               |
| Unit Entry Pre-Authorized        | boolean | No       | Whether unit entry is pre-authorized.                                                                       |
| Management Fee Type              | string  | No       | Fee type: 'Percent' or 'Flat'.                                                                              |
| Management Fee Amount            | number  | No       | Fee amount (percentage or dollar amount based on type).                                                     |
| Management Fee Start Date        | string  | No       | Start date for the management fee policy (MM/DD/YYYY format).                                               |
| Waive Management Fee When Vacant | boolean | No       | Whether to waive fees when property is vacant.                                                              |
| Management Fee Minimum           | number  | No       | Minimum fee amount.                                                                                         |
| Management Fee Maximum           | number  | No       | Maximum fee amount.                                                                                         |
| Lease Fee Type                   | string  | No       | Fee type: 'Flat' or 'Percent'.                                                                              |
| Lease Fee Amount                 | number  | No       | Fee amount (dollar amount or percentage based on type).                                                     |
| Lease Renewal Fee                | number  | No       | Fee for lease renewals.                                                                                     |
| Lease Fee Effective Date         | string  | No       | Effective date for the lease fee policy (MM/DD/YYYY format).                                                |
| Has Home Warranty                | boolean | No       | Whether the property has home warranty coverage.                                                            |
| Home Warranty Company            | string  | No       | Name of the home warranty company.                                                                          |
| Home Warranty Expiration         | string  | No       | Expiration date of the home warranty (MM/DD/YYYY format).                                                   |
| Warranty Policy Number           | string  | No       | Home warranty policy number.                                                                                |
| Warranty Contact Number          | string  | No       | Contact number for home warranty company.                                                                   |
| Site Manager First Name          | string  | No       | Site manager's first name.                                                                                  |
| Site Manager Last Name           | string  | No       | Site manager's last name.                                                                                   |
| Site Manager Phone               | string  | No       | Site manager's phone number.                                                                                |
| Additional Cash Accounts         | object  | No       | Additional cash GL & bank account combinations.                                                             |

**Outputs**

| Field                     | Type    | Description                                 |
| ------------------------- | ------- | ------------------------------------------- |
| Property Creation Results | object  | Results of property creation operations.    |
| Successful Creations      | integer | Number of properties successfully created.  |
| Total Attempts            | integer | Total number of property creation attempts. |

#### Get Tenants

Retrieve and search tenants from AppFolio

**Inputs**

| Field           | Type   | Required | Description                                                                                                                                                |
| --------------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tenant ID       | string | No       | Get a specific tenant by its ID.                                                                                                                           |
| Unit ID         | string | No       | Filter tenants by unit ID(s) - comma-separated for multiple.                                                                                               |
| Property ID     | string | No       | Filter tenants by property ID.                                                                                                                             |
| Status          | string | No       | Filter tenants by status (Current, Past, Future, Evict, Notice).                                                                                           |
| Move In On From | string | No       | Filter tenants who moved in on or after this date (ISO format).                                                                                            |
| Updated Since   | string | No       | Only return tenants updated since this date (ISO format or YYYY-MM-DD). Required if tenant\_id is not provided. Defaults to last 30 days if not specified. |

**Outputs**

| Field       | Type    | Description                              |
| ----------- | ------- | ---------------------------------------- |
| Tenants     | object  | List of tenants retrieved from AppFolio. |
| Total Count | integer | Total number of tenants found.           |
| Success     | boolean | Whether the request was successful.      |

#### Create Bill

Create a new bill in AppFolio

**Inputs**

| Field                       | Type    | Required | Description                                                                  |
| --------------------------- | ------- | -------- | ---------------------------------------------------------------------------- |
| Vendor URL                  | string  | Yes      | AppFolio vendor URL from the web interface.                                  |
| Total Amount                | number  | Yes      | Total amount of the bill.                                                    |
| Invoice Date                | string  | Yes      | The date the invoice was received (YYYY-MM-DD format).                       |
| Due Date                    | string  | Yes      | The date the bill is due (YYYY-MM-DD format).                                |
| Property ID                 | string  | Yes      | Unique identifier of the property associated with the bill (required).       |
| General Ledger Account ID   | string  | Yes      | General Ledger account ID for the bill line items.                           |
| Reference                   | string  | No       | Invoice number of the bill (optional).                                       |
| Remarks                     | string  | No       | A description or summary of the invoice (optional).                          |
| Work Order ID               | string  | No       | Unique identifier of the work order corresponding to the invoice (optional). |
| Posting Date                | string  | No       | Accrual-accounting invoice date of the bill (optional, YYYY-MM-DD format).   |
| Account Number              | string  | No       | Account number for utility billing (optional).                               |
| Approval Status             | string  | No       | Indicates the bill's approval status (optional).                             |
| Check Memo                  | string  | No       | The memo that will appear on the check (optional).                           |
| Management Company as Payee | boolean | No       | Whether the management company is the payee for the bill (optional).         |

**Outputs**

| Field   | Type    | Description                               |
| ------- | ------- | ----------------------------------------- |
| Bill ID | string  | ID of the newly created bill.             |
| Success | boolean | Whether the bill creation was successful. |
| Message | string  | Success or error message.                 |

#### Create Vendor

Create a new vendor in AppFolio

**Inputs**

| Field                             | Type    | Required | Description                                                                                |
| --------------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------ |
| Is Company                        | boolean | No       | Whether the vendor is a company (defaults to individual if not specified). Default: false. |
| First Name                        | string  | No       | Vendor's first name (required for individuals).                                            |
| Last Name                         | string  | No       | Vendor's last name (required for individuals).                                             |
| Company Name                      | string  | No       | Company name of the vendor (required for companies).                                       |
| Taxpayer Name                     | string  | No       | The taxpayer name of the vendor (optional).                                                |
| Taxpayer ID                       | string  | No       | The vendor's taxpayer identification (optional).                                           |
| Use Company Name as Taxpayer Name | boolean | No       | Whether to use company name for tax purposes (optional).                                   |
| Send 1099                         | boolean | No       | Whether the vendor needs a 1099 tax form (optional).                                       |
| Email                             | string  | No       | Vendor's email address (optional).                                                         |
| Phone Number                      | string  | No       | Vendor's phone number (optional).                                                          |
| Address Line 1                    | string  | No       | Primary street address of the vendor (optional).                                           |
| Address Line 2                    | string  | No       | Additional street address information (optional).                                          |
| City                              | string  | No       | City where the vendor is located (optional).                                               |
| State                             | string  | No       | State where the vendor is located (optional).                                              |
| ZIP Code                          | string  | No       | ZIP code where the vendor is located (optional).                                           |
| Country Code                      | string  | No       | Country code of the vendor (optional).                                                     |
| Company URL                       | string  | No       | Internet address of the vendor's website (optional).                                       |
| Liability Insurance Expiration    | string  | No       | Expiration date of liability insurance (optional).                                         |
| Auto Insurance Expiration         | string  | No       | Expiration date of auto insurance (optional).                                              |
| Workers Comp Expiration           | string  | No       | Expiration date of worker's compensation insurance (optional).                             |
| Contract Expiration               | string  | No       | Expiration date of the vendor's contract (optional).                                       |
| Umbrella Insurance Expiration     | string  | No       | Expiration date of umbrella insurance (optional).                                          |
| Compliant Status                  | boolean | No       | Whether the vendor meets compliance requirements (optional).                               |

**Outputs**

| Field     | Type    | Description                                 |
| --------- | ------- | ------------------------------------------- |
| Vendor ID | string  | ID of the newly created vendor.             |
| Success   | boolean | Whether the vendor creation was successful. |
| Message   | string  | Success or error message.                   |

#### Get Work Order Attachments

Get attachments for a specific work order from AppFolio

**Inputs**

| Field         | Type    | Required | Description                                                               |
| ------------- | ------- | -------- | ------------------------------------------------------------------------- |
| Work Order ID | string  | No       | UUID of specific work order to get attachments for.                       |
| Created From  | string  | No       | ISO-8601 datetime to filter attachments created after this time.          |
| Created To    | string  | No       | Optional upper bound for created time (ISO-8601 format).                  |
| Page Number   | integer | No       | Page number for pagination (default: 1). Default: 1.                      |
| Page Size     | integer | No       | Number of attachments per page (default: 1000, max: 1000). Default: 1000. |

**Outputs**

| Field          | Type    | Description                                   |
| -------------- | ------- | --------------------------------------------- |
| Attachments    | object  | List of work order attachments.               |
| Next Page Path | string  | Path for next page of results (if available). |
| Total Count    | integer | Total number of attachments found.            |
| Success        | boolean | Whether the request was successful.           |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/appfolio.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
