{"info":{"name":"Skywalk API","description":"REST API for AppFolio Property Manager data. Authenticate by setting the X-API-Key header variable.\n\nNote: Requests made with a key against production endpoints count toward your account's usage.","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"variable":[{"key":"baseUrl","value":"https://api.skywalkapi.com","type":"string"},{"key":"apiKey","value":"","type":"string","description":"Your Skywalk API key"}],"item":[{"name":"Property Information","description":"Get properties, property groups, portfolios and unit details.","item":[{"name":"Properties","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/properties?","host":["{{baseUrl}}"],"path":["v1","properties"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of properties."},"response":[]},{"name":"Property Groups","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/property-groups?","host":["{{baseUrl}}"],"path":["v1","property-groups"],"query":[{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of property groups."},"response":[]},{"name":"Units","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/units?","host":["{{baseUrl}}"],"path":["v1","units"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of units."},"response":[]},{"name":"Owners","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/owners?","host":["{{baseUrl}}"],"path":["v1","owners"],"query":[{"key":"ownerVisibility","value":"active","description":"Owner Visibility status to serve as filter.","disabled":true},{"key":"propertyVisibility","value":"active","description":"Property Visibility status to serve as filter.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of owners."},"response":[]},{"name":"Unit Vacancies","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/unit-vacancies?","host":["{{baseUrl}}"],"path":["v1","unit-vacancies"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"dateRange","value":"this_month_to_date","description":"Available Date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Available Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Available Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Unit vacancy details."},"response":[]}]},{"name":"Tenant Information","description":"Get tenant details.","item":[{"name":"Tenants","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/tenants?","host":["{{baseUrl}}"],"path":["v1","tenants"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"visibility","value":"active","description":"Tenant Visibility status to serve as filter.","disabled":true},{"key":"status","value":"current,notice","description":"Tenant Status to serve as filter.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of tenants."},"response":[]},{"name":"Tenant Ledger","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/tenant-ledger?","host":["{{baseUrl}}"],"path":["v1","tenant-ledger"],"query":[{"key":"occupancyId","value":"","description":"AppFolio ID of a Occupancy for the tenant ledger.","disabled":true},{"key":"dateRange","value":"all_time","description":"Date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get tenant ledger for a given tenant."},"response":[]},{"name":"Tenant Events","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/tenant-events?","host":["{{baseUrl}}"],"path":["v1","tenant-events"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"dateRange","value":"this_month","description":"Event date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Event date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Event date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"eventType","value":"all","description":"Filter events by type.\n      Possible Values: all, Move-in, Move-out, Notice","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get tenant events (move-ins, move-outs, notices)."},"response":[]},{"name":"Lease History","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/lease-history?","host":["{{baseUrl}}"],"path":["v1","lease-history"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"dateRange","value":"this_and_next_6_months","description":"Date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Date to given in MM/YYYY (e.g. 01/2021)","disabled":true},{"key":"dateTo","value":"","description":"Date to given in MM/YYYY (e.g. 01/2021)","disabled":true},{"key":"leaseStatus","value":"all","description":"Filter leases for a specific status.\n      Default: all.\n      Possible Values: all, Completed, Did Not Renew, Month To Month, Pending, Status Cannot Be Determined","disabled":true},{"key":"unitVisibility","value":"all","description":"Filter by unit visibility.\n      Default: all.\n      Possible Values: all, active, hidden","disabled":true},{"key":"tenantVisibility","value":"all","description":"Filter by tenant visibility.\n      Default: all.\n      Possible Values: all, active, hidden","disabled":true},{"key":"filterLeaseBy","value":"Lease Start Date","description":"Filter leases by date.\n      Default: Lease Start Date.\n      Possible Values: Lease Start Date, Lease Countersigned Date","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get lease history."},"response":[]}]},{"name":"Vendor Information","description":"Get information about Vendors.","item":[{"name":"Vendors","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/vendors?","host":["{{baseUrl}}"],"path":["v1","vendors"],"query":[{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of vendors."},"response":[]}]},{"name":"GL Accounts","description":"Get Chart of Accounts (General Ledger Accounts).","item":[{"name":"GL Accounts","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/gl-accounts?","host":["{{baseUrl}}"],"path":["v1","gl-accounts"],"query":[{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of GL Accounts."},"response":[]}]},{"name":"Financial Reports","description":"Get standard financial reports.","item":[{"name":"Balance Sheet","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/balance-sheet?","host":["{{baseUrl}}"],"path":["v1","balance-sheet"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"accounting","value":"cash","description":"Accounting Basis.\n      Default: cash.\n      Possible Values: cash, accrual","disabled":true},{"key":"date","value":"","description":"\"As of\" date for report given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"asOf","value":"end_of_this_month","description":"Relative \"as of\" date for the report. Ignored when `date` is supplied. Default: end_of_this_month. Possible Values: today, yesterday, end_of_last_week, end_of_last_month, end_of_last_quarter, end_of_last_year, end_of_this_month, end_of_this_quarter, end_of_this_year","disabled":true},{"key":"includeZeroBalanceGlAccounts","value":"No","description":"Include GL accounts whose balance is zero. Default: No. Possible Values: Yes, No","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the balance sheet statement."},"response":[]},{"name":"Bank Accounts","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/bank-accounts?","host":["{{baseUrl}}"],"path":["v1","bank-accounts"],"query":[{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of Bank Accounts."},"response":[]},{"name":"Bank Account Activity","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/bank-account-activity?","host":["{{baseUrl}}"],"path":["v1","bank-account-activity"],"query":[{"key":"bankAccountId","value":"","description":"AppFolio ID of the Bank Account to get activity for.","disabled":true},{"key":"dateRange","value":"this_month_to_date","description":"Date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get bank account activity for a given bank account."},"response":[]},{"name":"Cash Flow","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/cash-flow?","host":["{{baseUrl}}"],"path":["v1","cash-flow"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"accounting","value":"cash","description":"Accounting Basis.\n      Default: cash.\n      Possible Values: cash, accrual","disabled":true},{"key":"dateRange","value":"this_month_to_date","description":"Date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"ownerPercentBased","value":"No","description":"Reflect Owner % in reported numbers.\n      Default: No.\n      Possible Values: Yes, No","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the cash flow statement."},"response":[]},{"name":"Annual Budget Comparative","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/annual-budget-comparative?","host":["{{baseUrl}}"],"path":["v1","annual-budget-comparative"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"accounting","value":"cash","description":"Accounting Basis.\n      Default: cash.\n      Possible Values: cash, accrual","disabled":true},{"key":"date","value":"","description":"\"As of\" date for report given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the annual budget comparative statement."},"response":[]},{"name":"Rent Roll","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/rent-roll?","host":["{{baseUrl}}"],"path":["v1","rent-roll"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"date","value":"","description":"\"As of\" date for report given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get rent roll of properties."},"response":[]},{"name":"Rent Roll Recurring","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/rent-roll-recurring?","host":["{{baseUrl}}"],"path":["v1","rent-roll-recurring"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"date","value":"","description":"\"As of\" date for report given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"glAccountIds","value":"","description":"GL Account IDs to fitler.\n      Default: ''.\n      Possible Values: Comma Separated list of gl account Ids","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get list of recurring rent roll charges of properties."},"response":[]},{"name":"General Ledger","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/general-ledger?","host":["{{baseUrl}}"],"path":["v1","general-ledger"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"accounting","value":"cash","description":"Accounting Basis.\n      Default: cash.\n      Possible Values: cash, accrual","disabled":true},{"key":"dateRange","value":"this_month_to_date","description":"Post Date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Post Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Post Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"glAccountId","value":"all","description":"GL account ID to filter by, or \"all\" to include all accounts. Default: all.","disabled":true},{"key":"reverseTransaction","value":"No","description":"Include reverse transactions. Default: No. Possible Values: Yes, No","disabled":true},{"key":"excludeZeroDollarReceiptsFromCashAccounts","value":"Yes","description":"Exclude zero-dollar receipts from cash accounts. Default: Yes. Possible Values: Yes, No","disabled":true},{"key":"excludeZeroDollarBills","value":"Yes","description":"Exclude zero-dollar bills. Default: Yes. Possible Values: Yes, No","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get general ledger transactions."},"response":[]},{"name":"Income Statement","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/income-statement?","host":["{{baseUrl}}"],"path":["v1","income-statement"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"accounting","value":"cash","description":"Accounting Basis.\n      Default: cash.\n      Possible Values: cash, accrual","disabled":true},{"key":"asOfDate","value":"","description":"As-of month/year given in MM/YYYY (e.g. 03/2026). Defaults to the current month.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the income statement (profit & loss) report."},"response":[]},{"name":"Gross Potential Rent","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/gross-potential-rent?","host":["{{baseUrl}}"],"path":["v1","gross-potential-rent"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"month","value":"","description":"Month of the report (1-12).","disabled":true},{"key":"year","value":"","description":"Year of the report (e.g. 2026).","disabled":true},{"key":"propertyVisibility","value":"active","description":"Filter by property visibility. Default: active.","disabled":true},{"key":"accounting","value":"cash","description":"Accounting Basis.\n      Default: cash.\n      Possible Values: cash, accrual","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the Gross Potential Rent report for your properties."},"response":[]}]},{"name":"Leasing","description":"Get standard leasing reports.","item":[{"name":"Unit Photos","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/unit-photos?","host":["{{baseUrl}}"],"path":["v1","unit-photos"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property for the photos.","disabled":true},{"key":"unitId","value":"","description":"AppFolio ID of a Unit for the photos.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of unit photos."},"response":[]},{"name":"Lead Source Tracking","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/lead-source-tracking?","host":["{{baseUrl}}"],"path":["v1","lead-source-tracking"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"dateRange","value":"this_month_to_date","description":"Date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get metrics on lead sources."},"response":[]},{"name":"Guest Cards","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/guest-cards?","host":["{{baseUrl}}"],"path":["v1","guest-cards"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"dateRange","value":"this_month_to_date","description":"Date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"leadStatus","value":"all","description":"Filter guest cards for a specific status.","disabled":true},{"key":"leadType","value":"all","description":"Filter guest cards for a specific type.\n      Default: all.\n      Possible Values: all, Free, Premium, Hang Up, Refunded","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get guest cards."},"response":[]},{"name":"Rental Applications","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/rental-applications?","host":["{{baseUrl}}"],"path":["v1","rental-applications"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"dateRange","value":"this_month_to_date","description":"Application \"Received On\" Date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Application \"Received On\" Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Application \"Received On\" Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"applicationStatus","value":"all","description":"Filter guest cards for a specific status.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get rental applications."},"response":[]},{"name":"Showings","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/showings?","host":["{{baseUrl}}"],"path":["v1","showings"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"dateRange","value":"this_month_to_date","description":"Showing Date Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Showing Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Showing Date to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"status","value":"all","description":"Filter showings for a specific status. Default: all.","disabled":true},{"key":"assignedUser","value":"","description":"Filter showings for a specific assigned user. Accepts the AppFolio user display name (e.g. \"Jane Manager\") or AppFolio user ID. Default: All.","disabled":true},{"key":"propertyVisibility","value":"active","description":"Filter by property visibility. Default: active.","disabled":true},{"key":"sortOrder","value":"desc","description":"Sort order for ShowingTime. Default: desc.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of property showings."},"response":[]},{"name":"Leasing Summary","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/leasing-summary?","host":["{{baseUrl}}"],"path":["v1","leasing-summary"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"dateRange","value":"this_month_to_date","description":"Report period Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Report period to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Report period to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the Leasing Summary report for your properties. Returns per-unit-type (or per-property) counts for inquiries, showings, applications, move-ins, move-outs, and leases executed. Portfolio-level totals are exposed in meta.summary."},"response":[]},{"name":"Renewal Summary","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/renewal-summary?","host":["{{baseUrl}}"],"path":["v1","renewal-summary"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"dateRange","value":"this_and_next_6_months","description":"New lease start Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"New lease start to given in MM/YYYY (e.g. 01/2021)","disabled":true},{"key":"dateTo","value":"","description":"New lease start to given in MM/YYYY (e.g. 01/2021)","disabled":true},{"key":"status","value":"All","description":"Filter by renewal status. Default: All. Possible values: All, Renewed, Not Renewed, Month To Month, Pending, Canceled By User","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the Renewal Summary report for your properties. Returns per-lease renewal details (previous vs new rent, dollar/percent change, status, term) for leases whose new start date falls in the report window."},"response":[]}]},{"name":"Maintenance","description":"Get standard maintenance reports.","item":[{"name":"Work Orders","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/work-orders?","host":["{{baseUrl}}"],"path":["v1","work-orders"],"query":[{"key":"propertyId","value":"","description":"AppFolio ID of a Property to serve as a filter.","disabled":true},{"key":"propertyGroupId","value":"","description":"AppFolio ID of a Property Group to serve as a filter.","disabled":true},{"key":"ownerId","value":"","description":"AppFolio ID of an Owner to serve as a filter.","disabled":true},{"key":"occupancyId","value":"","description":"AppFolio ID of an Occupancy. When provided, returns only work orders for that occupancy.","disabled":true},{"key":"status_date","value":"All","description":"Filter work orders by date of a specific status.","disabled":true},{"key":"dateRange","value":"this_month_to_date","description":"Status Date Range Range for report.","disabled":true},{"key":"dateFrom","value":"","description":"Status Date Range to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"dateTo","value":"","description":"Status Date Range to given in MM/DD/YYYY (e.g. 01/31/2021)","disabled":true},{"key":"priority","value":"All","description":"Filter work orders for a specific priority.","disabled":true},{"key":"type","value":"All","description":"Filter work orders for a specific type.","disabled":true},{"key":"status","value":"All","description":"Filter work orders for a specific status.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get work orders."},"response":[]}]},{"name":"Write Data","description":"Creatable items.","item":[{"name":"Tenant Charge","request":{"method":"POST","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/tenant-charge","host":["{{baseUrl}}"],"path":["v1","tenant-charge"],"query":[]},"description":"Create a tenant charge for a given tenant.","body":{"mode":"raw","raw":"{\n  \"occupancyId\": \"\",\n  \"amount\": \"\",\n  \"chargeDate\": \"\",\n  \"postingDate\": \"\",\n  \"glAccountId\": \"\",\n  \"description\": \"\",\n  \"warningsOk\": \"\"\n}","options":{"raw":{"language":"json"}}}},"response":[]}]},{"name":"Attachments","description":"Get attachment details and download URLs.","item":[{"name":"Attachments","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/attachments?","host":["{{baseUrl}}"],"path":["v1","attachments"],"query":[{"key":"occupancyId","value":"","description":"AppFolio ID of the occupancy to get attachments for.","disabled":true},{"key":"workOrderId","value":"","description":"AppFolio ID of the work order to get attachments for.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of attachments for an occupancy or a work order."},"response":[]},{"name":"File","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/file?","host":["{{baseUrl}}"],"path":["v1","file"],"query":[{"key":"id","value":"","description":"AppFolio ID of the attachment to download.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the file for an attachment."},"response":[]},{"name":"Letters","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/letters?","host":["{{baseUrl}}"],"path":["v1","letters"],"query":[{"key":"occupancyId","value":"","description":"AppFolio ID of the occupancy.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of letters for an occupancy."},"response":[]},{"name":"Lease Documents","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/lease-documents?","host":["{{baseUrl}}"],"path":["v1","lease-documents"],"query":[{"key":"occupancyId","value":"","description":"AppFolio ID of the occupancy.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of lease documents for an occupancy."},"response":[]}]},{"name":"Communications","description":"Get emails and other communications.","item":[{"name":"Emails","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/emails?","host":["{{baseUrl}}"],"path":["v1","emails"],"query":[{"key":"guestCardId","value":"","description":"AppFolio ID of the guest card to get emails for.","disabled":true},{"key":"occupancyId","value":"","description":"AppFolio ID of the occupancy to get emails for.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of emails for a guest card or occupancy."},"response":[]},{"name":"Email","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/email?","host":["{{baseUrl}}"],"path":["v1","email"],"query":[{"key":"emailId","value":"","description":"AppFolio ID of the email to fetch.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the body and details of a single email."},"response":[]},{"name":"SMS","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/sms?","host":["{{baseUrl}}"],"path":["v1","sms"],"query":[{"key":"toNumber","value":"","description":"Phone number to get text messages for. Accepts any common US format; normalized to `(XXX) XXX-XXXX`.","disabled":true},{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of text messages for a phone number."},"response":[]}]},{"name":"User Management","description":"Get AppFolio user accounts and details.","item":[{"name":"Users","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/users?","host":["{{baseUrl}}"],"path":["v1","users"],"query":[{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get a list of AppFolio users."},"response":[]},{"name":"Current User","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/me?","host":["{{baseUrl}}"],"path":["v1","me"],"query":[{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the current authenticated AppFolio user details."},"response":[]},{"name":"User Roles","request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{apiKey}}","description":"Your Skywalk API key"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/user-roles?","host":["{{baseUrl}}"],"path":["v1","user-roles"],"query":[{"key":"cursor","value":"","description":"Pagination cursor from links.next","disabled":true}]},"description":"Get the current user's role and permissions."},"response":[]}]}]}