Prospects Overview

The Prospects API provides endpoints for managing potential tenants and their preferences throughout the leasing process.

Key Concepts

Prospect Information

Prospects contain essential contact and preference information:

  • Contact Details: Name, email, and phone information
  • Property Association: Each prospect is linked to a specific property
  • Referral Tracking: Source of how the prospect found the property

Prospect Preferences

Prospects can specify their housing preferences:

  • Unit Requirements: Number of bedrooms, bathrooms, and half-bathrooms
  • Pricing Range: Minimum and maximum price preferences
  • Lease Terms: Preferred lease duration
  • Move-in Timeline: Desired move-in date range
  • Additional Notes: Other specific requirements

Available Endpoints

EndpointSummaryMethod
/prospectsList ProspectsGET
/prospectsCreate ProspectPOST
/prospects/{prospectId}Read ProspectGET