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

Prospect Statuses

ProspectStatus is fixed, platform-wide master data — the same 14 statuses with the same ids exist in every environment, and the catalogue has no organizationId or propertyId. Fetch it via the list endpoint below and send the returned id as prospectStatusId when updating a prospect’s status.

Prospect Updates

Available by Request

Prospect contact information and preferences can be updated after creation via a partial update — only the fields supplied in the request body are modified. A prospect’s leasing status can also be updated independently via a dedicated status endpoint.

Available Endpoints