Skip to content
Vespy API
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Getting started
Overview
Quickstart
Authentication
Errors
Filtering and sorting
Rate limits
Webhooks
Workflow guides
Set up your portfolio
Configure organization settings
Import portfolio data
Add team members
Add a property
Add an owner
Lease and collect rent
Draft a lease with AI
Invite a tenant
Bill and collect rent
Handle a security deposit
Renew or end a lease
Handle maintenance
Manage maintenance requests
Add and pay a vendor
Manage finances
Set up management fees
Chart of accounts and transactions
Close the books each month
Run and export financial reports
Run your operations
Manage documents
Message tenants and vendors
Manage notifications and send a blast
Integrations
Connect Gmail
Sync with QuickBooks Online
Understand your portfolio
View portfolio analytics
Use the AI portfolio assistant
Tenant portal
Accept your invitation
Pay rent and set up autopay
Submit a maintenance request
View your lease and documents
Message property management
Manage notifications
Vendor portal
Get started
View and comment on work orders
Upload compliance documents
Manage messages and notifications
API Guides
Onboarding a property
Rent and payments
Security deposits and trust accounting
Work order lifecycle
Migrating with import bundles
Exporting to QuickBooks Online
API Reference
Overview
System
Overview
Health check
API build version
Auth
Overview
Login
Logout
Get current user
Update current user email notification consent
Update current user notification phone
Mark onboarding as complete
Refresh access token
Accounts
Overview
Get current organization
Update current organization
List users in current organization
Create user in current organization
Get user in current organization
Update user in current organization
Soft-delete user in current organization
Dashboard
Overview
Get recent activity feed events
Get dashboard summary
Analytics
Overview
Average days vacant between tenancies, and the rent it cost
Monthly delinquency rate by tenants and by rent past due
Monthly economic occupancy against gross potential rent
Forward-looking lease expiration schedule
Move-outs per month (realized turnover)
Monthly net operating income (operating income minus operating expenses)
New leases and move-ins per month
Monthly physical occupancy rate time-series
Monthly operating expense ratio
Monthly operating expenses broken out by category
Outstanding receivables at each month end, split into aging bands
Monthly lease renewal rate
Monthly rent owed vs rent collected time-series
Work orders created and completed per month, with average resolution time
Reports
Overview
Get balance sheet report
Get budget vs actual report
Get cash flow report
Get delinquency report
Get general ledger report
Get GPR vs EGI report
Get lease expirations report
Get maintenance costs report
Get profit and loss report
Get rent roll report
Get security deposit ledger report
Create report snapshot
List report drill-down transactions
Search
Overview
Run federated search across portfolio entities
Refresh global search index
Properties
Overview
List properties
Create property
Get property by id
Update property
Delete property
List leases for a property
List units for a property
Create unit for a property
Get unit by id for a property
Update unit for a property
Delete unit for a property
Units
Overview
List units across the authenticated organization
Create a unit
Get unit by id
Update a unit
Delete a unit
List leases for a unit
List unit fee templates
Create unit fee template
Delete unit fee template
Update unit fee template
Leases
Overview
List leases
Create lease
Get lease by id
Update lease details
Soft-delete lease by id
Renew an active lease
Update lease status
Terminate an active lease early with optional deposit reconciliation
Tenants
Overview
List tenants
Create tenant
Get tenant by id
Update tenant by id
Soft-delete tenant by id
Get tenant ledger
Tenant Invites
Overview
List tenant invites
Create and send tenant invite
Revoke tenant invite
Validate tenant invite token
Accept tenant invite
Short Links
Overview
Follow a short link
Owners
Overview
List owners
Create owner
Get owner by id
Update owner by id
Soft-delete owner by id
Get owner ledger
Vendors
Overview
List vendors with note and compliance summaries
Create a vendor
Get a vendor with work orders, expenses, and compliance
Update a vendor
Soft-delete a vendor
Vendor Invites
Overview
List vendor invites
Create and send vendor invite
Revoke vendor invite
Validate vendor invite token
Accept vendor invite
Vendor Portal
Overview
Get vendor portal dashboard
List vendor compliance documents
Upload a vendor compliance document
Get signed download URL for vendor document
List work orders assigned to vendor
Get work order detail for vendor
Add a comment to a work order
Portal
Overview
Get the authenticated owner ledger
Get tenant portal dashboard
List tenant and lease documents for the authenticated tenant
Get a signed download URL for an accessible tenant portal document
Get the current or most recent lease for the authenticated tenant
Get the tenant ledger for the current month
List maintenance requests for the authenticated tenant
Create a maintenance request for the authenticated tenant
Get a maintenance request for the authenticated tenant
Upload an attachment for a tenant maintenance request
Add a tenant-visible comment to a maintenance request
Work Orders
Overview
List work orders with note summaries
Create a work order
Get a work order with notes, expenses, and attachments
Update a work order
Assign a work order to a vendor or staff user
List notes on a work order
Add a note to a work order
Transition a work order status
Inspections
Overview
List inspections for a lease
Create an inspection for a lease
Notes
Overview
List notes attached to an entity
Create a note on an entity
Update a note body or visibility
Delete a note
Documents
Overview
List documents
Upload document
Create document expiry alerts
List document entity options
Get document by id
Update document metadata
Soft-delete document by id
Download document by id
Get signed download URL for document
Queue document AI reanalysis
Accounting
Overview
List accounting category rollups (deprecated)
List manual journal entries
Create manual journal entry
Post draft manual journal entry
Reverse manual journal entry
List accounting periods
Close accounting period
Get accounting period pre-close checks
Reopen accounting period
Soft close accounting period
List grouped accounting activity
List unified accounting transactions
Get trial balance
Categories
Overview
List chart of accounts categories
Categories are system-managed
Categories are system-managed
Charges
Overview
List charges
Create charge
Get charge by id
Update charge
Void charge
Recurring Charges
Overview
List recurring charge rules
Create recurring charge rule
Get recurring charge rule by id
Delete recurring charge rule
Update recurring charge rule
Pause recurring charge rule
Resume recurring charge rule
Payments
Overview
List payments
Create payment
Get payment by id
Reject payment updates
Allocate payment to charges
Update payment allocation
Remove payment allocation
Reverse payment
Transition a pending payment
Online Payments
Overview
Issue a fresh Stripe Connect onboarding link
Start or resume Stripe Connect onboarding
Get Stripe Connect onboarding status
Get the autopay schedule for the authenticated tenant
Enroll the authenticated tenant in autopay
Cancel autopay for the authenticated tenant
Update the autopay payment method or status
List saved payment methods for the authenticated tenant
Save a payment method from a completed setup intent
Create a Stripe setup intent for a new payment method
Remove a saved payment method
Create a payment intent for selected charges
List charges the authenticated tenant can pay
Create a Stripe Checkout session for the platform subscription
Create a Stripe billing portal session
Get the organization platform billing status
Expenses
Overview
List expenses
Create expense
Get expense by id
Update expense
Void expense
ExpensePayments
Overview
List expense payments
Create expense payment
Get expense payment by id
Allocate expense payment to expenses
Remove expense payment allocation
Void expense payment
Management Fees
Overview
List management fee rules
Create a management fee rule
End or cancel a management fee rule
Revise a management fee rule for a future period
List management fee calculation runs
Budgets
Overview
List budgets
Create or update budget
Patch budget
Trust
Overview
List trust bank accounts
Create trust bank account
Archive trust bank account
Update trust bank account
List security deposits
Record security deposit
Get security deposit detail
Download itemized deduction statement
Record security deposit disposition
List trust ledger entries
List owner payables
Create owner payable
Mark owner payable paid
Void owner payable
List trust reconciliations
Run trust reconciliation
Get trust reconciliation
List owner subledger balances
Bulk Imports
Overview
List bulk imports
Upload and validate a bulk import CSV
Export resources as CSV
List bulk import resource definitions
Download a bulk import CSV template
Get a bulk import
Download bulk import failures
List bulk import row results
Start a validated bulk import
Import Bundles
Overview
List import bundles
Create an import bundle
Download all migration bundle templates for a provider
Get an import bundle
Cancel an import bundle
List import bundle candidates
Resolve an import bundle candidate
Download bundle failures
Upload import bundle CSV files
Delete a draft bundle file
Update bundle file mapping
Download bundle identity map
List import bundle results
Start an import bundle
Validate an import bundle
List import mapping profiles
Save an import mapping profile
Delete an import mapping profile
Integrations
Overview
List visible integration connections
List integration provider definitions
Begin Gmail OAuth connection
Gmail OAuth redirect target
Gmail OAuth redirect target
List QuickBooks Online chart-of-accounts entries for mapping
Begin QuickBooks Online OAuth connection
Queue an export of Vespy transactions to QuickBooks Online
List per-transaction QuickBooks export results
Get QuickBooks export status for the organization
List QuickBooks account mappings
Replace QuickBooks account mappings
Create and save required QuickBooks account mappings
QuickBooks Online OAuth redirect target
QuickBooks Online OAuth redirect target
Get one visible integration connection
Update a manageable integration connection
Delete a manageable integration connection
Communication
Overview
List organization email accounts
Create an organization email account
Get an organization email account
Update an organization email account
Delete an organization email account
Conversations
Overview
List conversations for current user
Create a conversation
List conversation participants for staff inbox
Send a message to a participant
Mark a participant inbox read
Get a participant message timeline
Get unread conversation count for current user
Get conversation detail
Update conversation status
Export conversation as PDF
Send a message in a conversation
Mark a conversation as read
Search messages
Notifications
Overview
Get grouped notification preferences for the current user
Update grouped notification preferences for the current user
List notifications for current user
Preview a custom notification blast
Queue an approved notification blast
Preview the pending digest email for the current admin user
Send the pending digest email immediately for the current admin user
List organization notification delivery history
List notification history recipient filter options
Get an organization notification history item
Mark all notifications as read for current user
Mark selected notifications as read for current user
Send a test notification to the current user on a single channel
Get unread notification count for current user
Get a notification with its per-channel deliveries
Mark a notification as read
Get organization notification settings
Update organization notification settings
Tools
API playground
Select theme
Dark
Light
Auto
Gmail and QuickBooks Online guides
The integration workflows now have separate guides:
Connect Gmail
Sync with QuickBooks Online