Leases

List leases for a property

Retrieve all leases associated with a specific property

get/leases/estate/{estate_id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/estate/{estate_id}
  • Auth: HTTP bearer

Path parameters

estate_idstring uuid required

Property ID

Response

Lease list retrieved successfully

idstring uuid required
estate_idstring uuid required
reference_numberstring nullable
status'DRAFT' | 'PENDING_SIGNATURE' | 'ACTIVE' | 'NOTICE' | 'FINALISATION' | 'TERMINATED' | 'EXPIRED' required

Lease status

start_datestring date required
end_datestring date nullable
rent_amountnumber required
rent_frequency'MONTHLY' | 'QUARTERLY' | 'ANNUALLY' required

Rent payment frequency

lessee_namestring nullable

Formatted name of the primary tenant (PRIMARY role). Format: 'FirstName LastName' for individuals, 'Business Name' for companies. NULL if no tenant.

estate_namestring nullable

Name of the associated property. NULL if property deleted.

place_namestring nullable

Name or address of the place where the property is located. NULL if not defined.

deposit_amountnumber nullable

Security deposit amount

Example response

[
  {
    "status": "ACTIVE",
    "rent_frequency": "MONTHLY"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.