界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
效率与协作 · SKILL.md

appfolio-hello-world

appfolio-hello-world

【效率与协作】Query AppFolio properties, units, and tenants via REST API. Trigger: "appfolio hello world".

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: appfolio-hello-world description: 'Query AppFolio properties, units, and tenants via REST API.

Trigger: "appfolio hello world".

' allowed-tools: Read, Write, Edit, Bash(npm:), Bash(curl:), Grep version: 1.5.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io tags:

  • saas
  • property-management
  • appfolio
  • real-estate compatibility: Designed for Claude Code

AppFolio Hello World

Overview

Get started with the AppFolio Property Manager API through a verified provider-issued client configuration. This skill walks through safe first reads for a property listing and a tenant count; create or update operations belong only in a separately approved synthetic sandbox workflow.

Prerequisites

  • AppFolio Stack Partner account with API access
  • A managed, provider-issued base URL and authentication client confirmed for the target portfolio; do not use a guessed hostname or credential scheme
  • Node.js 18+ and TypeScript

Instructions

Step 1: Configure the Client

async function appfolioFetch(path: string) {
  const res = await createVerifiedAppFolioClient().get(path);
  if (res.status < 200 || res.status >= 300) throw new Error(`AppFolio ${res.status}`);
  return res.data;
}

Step 2: List Properties

const properties = await appfolioFetch("/properties?page_size=10");
console.log(`Found ${properties.length} properties`);
properties.forEach((p: any) => console.log(`  property ID: ${p.id}`));

Step 3: Get Tenant Details

const tenants = await appfolioFetch(`/tenants?property_id=${properties[0].id}`);
console.log(`Retrieved ${tenants.length} tenant records for the approved fixture`);

Step 4: Stop Before Writes

// Do not create a work order as a quickstart test. Continue only with the
// synthetic, idempotent workflow in appfolio-core-workflow-b.

Output

A successful run proves the managed client and an approved safe-read endpoint work, returning only property IDs and a tenant-record count in its local output.

Examples

For a first integration check, configure the verified sandbox client, query one approved synthetic property page, and confirm its status, property IDs, and tenant count without recording addresses, names, unit numbers, or credentials. Do not create a work order merely to test access. If the portfolio contract, safe-read fixture, or response authorization is not verified, stop the run and use the credential owner’s staging process before attempting any mutation.

Error Handling

ErrorCauseSolution
401 UnauthorizedInvalid client_id or secretVerify credentials in environment variables
403 ForbiddenAPI scope not grantedCheck Stack Partner permissions for the endpoint
404 Not FoundWrong base URL or endpointConfirm your company subdomain and API version
422 UnprocessableMissing required fieldsValidate property_id and required body params
429 Too Many RequestsRate limit exceededAdd backoff delay, batch requests

Resources

Next Steps

See appfolio-core-workflow-a for full property and tenant management workflows.

我的收藏