Estates

List archived estates

Retrieve the estates that have been archived for the authenticated tenant.

Archiving is how you retire a property without deleting it: the estate keeps its history (leases, diagnostics, meters) but stops counting against your plan's active-property quota. GET /estates returns only the active ones, so this endpoint is the only way to see the archived ones back.

Archive with PUT /estates/{id}/archive, restore with PUT /estates/{id}/unarchive.

get/estates/archived

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/estates/archived
  • Auth: HTTP bearer

Response

OK

idstring uuid nullable
namestring nullable

Property name

place_idstring uuid nullable
estate_type_idstring uuid nullable
areanumber nullable
number_of_roominteger nullable
orientationstring nullable
buildingstring nullable
floorinteger nullable
owner_idstring uuid nullable
previous_owner_idstring uuid nullable
lot_numberstring nullable
fiscal_identifierstring nullable

Property tax identifier (required)

housing_taxnumber nullable
property_taxnumber nullable
acquisition_pricenumber nullable
rent_amountnumber nullable

Reference rent amount for the property (in euros). Automatically synchronized with active leases.

rental_status'VACANT' | 'RENTED' | 'NOTICE'

Rental status of a property.

  • VACANT: Vacant property, no active lease
  • RENTED: Rented property, at least one active lease
  • NOTICE: Property under notice period, at least one lease under notice (without an active lease)

This status is automatically synchronized with the status of associated leases when statuses change (ACTIVE, NOTICE, TERMINATED).

construction_datestring date-time nullable
renovation_datestring date-time nullable
addressstring nullable
other_detailstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Example response

[
  {
    "name": "3-bedroom apartment - Rue de la Paix",
    "fiscal_identifier": "1234567890123",
    "rent_amount": 1200,
    "rental_status": "RENTED"
  }
]

Changes

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