Purpose and Use Cases

This API enables landlords to update property information on https://Student.com in real-time and receive instant notifications about new and updated orders

Target Users

Landlords looking to seamlessly sync their property listings with https://Student.com.

Version and Release Date

Version Release Date Change Notes
V1.0.0 2024-3-26 Add sync Book listing plan property
V2.0.0 2024-10-29 Remove manual listing plan property
V3.0.0 2024-12-16 Add sync List listing plan property
V4.0.0 2025-6-23
  • Completely reorganized the entire API documentation (excluding the PMS Integration Process module)
  • Added the following endpoints:
    • getLeadsList
    • getLeads
    • getLead
    • /api/v1/download/lead/document
    • bindPropertiesToPaymentPlan
    • unbindPropertiesToPaymentPlan

Open API Integration Process

  1. Contact your Account Manager to express your intent to integrate.
  2. Choose a listing plan (LIST, BOOK, or CONNECT).
  3. Your Account Manager provides a testing-environment token.
  4. Connect to the test environment:
    • Complete general settings as described in the “General Steps” module.
    • Implement the APIs required for your chosen listing plan.
  5. After successful testing, switch to the production environment and repeat the configuration steps.

Listing Plan Terminology

Please note that the listing plan names used in the code and in error messages are inconsistent.
Refer to the mapping below:
SEMI_AUTOMATIC → book
INSTANT_BOOK → connect
LEAD_GENERATION → list