Places

List places

get/places

Request

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

Query parameters

searchstring

Free-text search over name and address (street, city, postcode, country).

namestring
addressstring
ban_idstring

Base Adresse Nationale key. Exact match: this is what deduplicates addresses.

citystring
postal_codestring
countrystring
place_type_idstring uuid
owner_idstring uuid
created_afterstring date
created_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
countrystring nullable
address_complementstring nullable
street_numberstring nullable
street_namestring nullable
localitystring nullable
postal_codestring nullable
citystring nullable
postal_boxstring nullable
latitudenumber nullable
longitudenumber nullable
descriptionstring nullable
type_idstring uuid nullable
country_idstring uuid nullable
digicodestring nullable
number_of_floorinteger nullable
owner_idstring uuid nullable
previous_owner_idstring uuid nullable
construction_datestring date-time nullable
renovation_datestring date-time nullable
place_category'Individual' | 'Collective'

Place category (individual or collective)

legal_regime'MonoPropriete' | 'Copropriete'

Legal regime of the place

created_atstring date-time nullable
updated_atstring date-time nullable

Example response

[
  {
    "place_category": "Collective",
    "legal_regime": "Copropriete"
  }
]

Changes

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