Tenant Portal API Routes
Tenant Portal API Routes
Introduced in: v0.1.22
myProp provides dedicated Next.js API routes for two types of tenant portal users: Active Tenants (currently renting a property) and Prospect Tenants (searching for or applying for a property). Each route connects to the AgentOS platform to return real-time data.
Active Tenant Portal
The active tenant API route returns bundled tenancy data for a currently renting tenant. This single endpoint aggregates the information needed to power an active tenant's dashboard view.
What it returns
- Bundled tenancy data from AgentOS, including tenancy details relevant to the authenticated tenant.
Prospect Tenant Portal
Prospect tenant API routes cover the end-to-end journey from property discovery through to viewing and application. There are multiple routes serving distinct parts of the prospect experience.
Application Pre-fill Data
Retrieves any previously stored applicant information associated with the prospect. This data is used to pre-populate application forms, reducing friction when a prospect is ready to apply.
Advertised Properties
Fetches active property listings from the AgentOS platform that are relevant to the prospect, enabling the portal to display available properties for rent.
Preferences
Retrieves the prospect tenant's stored search preferences (e.g. location, property type, budget). These preferences are surfaced within the portal to personalise the property discovery experience.
Viewing Scheduling
Allows prospect tenants to schedule viewings for properties directly through the portal. This route connects to AgentOS to manage viewing slots and availability.
Notes
- All routes are implemented as Next.js API routes and connect to the AgentOS (letmc.com) API.
- Authentication is required to access tenant-specific data.
- These routes are consumed by the client-side portal UI — they are not intended to be called directly by end users.