Estates

List estates for place

get/places/{id}/estates

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/places/{id}/estates
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

searchstring

Free-text search over name, address and fiscal identifier.

namestring
addressstring
fiscal_identifierstring
estate_type_idstring uuid
rental_statusstring

VACANT, RENTED or NOTICE. Case-insensitive.

place_idstring uuid
citystring
postal_codestring
rent_amount_minnumber
rent_amount_maxnumber
area_minnumber
area_maxnumber
number_of_rooms_mininteger
number_of_rooms_maxinteger
owner_idstring uuid
has_ownerboolean

Keep only estates that do (or do not) have an owner.

archivedboolean

Omit it and only active estates come back. true returns only archived ones, false only active ones.

construction_date_afterstring date
construction_date_beforestring date
pageinteger

Zero-based page index. The first page is 0.

limitinteger

Rows per page. Defaults to 50.

sort_bystring

Field to sort on (created_at, last_name, email, …).

sort_order'asc' | 'desc'

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.