API Documentation

« Back to Home

Table of Contents

• Introduction
  • Terms of Use
  • Getting Started Guide
  • Who do I ask for support?
• How to Access the API Data
  • Getting Your Authorized API Key
  • API Data Display Preferences
  • Authentication
  • AJAX Authentication
• How to add a Prospect
  • Through the API
  • Through the lead capture widget
  • Via Email parsing
• Listings Search Endpoint
  • explanation of search parameters
  • example request and response
  • glossary of listing object fields
• Single Listing Endpoint
  • example request and response
  • glossary of listing object fields
• Listings Sync Endpoint
  • glossary of listings sync object fields
• Community Endpoint
• Prospects Endpoint
• Appointments
  • Available Appointment Times Endpoint
  • Appointment Booking Endpoint
  • Example Appointment Booking Flow
  • Prospect Appointments Endpoint
  • Appointment Deletion Endpoint
  • Appointment Reschedule Endpoint
• Discovery Sources Endpoint
• Employee Group Endpoint
• Online Leasing Link Endpoint
• Community Floorplans Endpoint