FairePlace Property Management API
stringstringstringstringstringstringstring · uuidstring · uuidstring · date-timestring · date-timeinteger · min: 1integer · min: 1 · max: 100string · enumstring · enumstring | null · uuidstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullnumber | nullnumber | nullstring | nullstring | null · uuidstring | null · uuidstring | nullinteger | nullstring | null · uuidstring | null · uuidstring | null · date-timestring | null · date-timestring · enumstring · enumstring | null · date-timestring | null · date-time
string · requiredstring · uuid · requiredstring · uuid · requiredstring · uuid · requiredstring · requiredstring · requiredstring · requiredstring · requiredstring · requiredstring · requiredstring | nullstring | nullstring | nullstring | nullnumber | nullnumber | nullstring | nullstring | nullinteger | nullstring | null · date-timestring | null · date-timestring | null · uuidstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullnumber | nullnumber | nullstring | nullstring | null · uuidstring | null · uuidstring | nullinteger | nullstring | null · uuidstring | null · uuidstring | null · date-timestring | null · date-timestring · enumstring · enumstring | null · date-timestring | null · date-time
string · uuid · requiredstring | null · uuidstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullstring | nullnumber | nullnumber | nullstring | nullstring | null · uuidstring | null · uuidstring | nullinteger | nullstring | null · uuidstring | null · uuidstring | null · date-timestring | null · date-timestring · enumstring · enumstring | null · date-timestring | null · date-time
string · uuid · required
string · uuid · requiredstring | null · uuidstring | null · uuidstring | null · uuidstring | nullstring | nullboolean | nullstring | null · uuidstring · enumstring | null · uuidstring | null · date-time
Building/residence management
List places
GET
https://api.faireplace.com/api
/places
query Parameters
searchGlobal text search
nameFilter by name
addressFilter by address
cityFilter by city
postal_codeFilter by postal code
countryFilter by country
place_type_idFilter by place type
owner_idFilter by owner
created_afterMinimum creation date (ISO 8601)
created_beforeMaximum creation date (ISO 8601)
pagePage number (default: 1)
Default: 1
limitNumber of items per page (default: 20, max: 100)
Default: 20
sort_bySort field
Enum values:
name
city
postal_code
created_at
sort_orderSort order
Enum values:
asc
desc
List places › Responses
OK
object[]
idnamecountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxlatitudelongitudedescriptiontype_idlegislative_zone_iddigicodenumber_of_floorowner_idprevious_owner_idconstruction_daterenovation_dateplace_categoryPlace category (individual or collective)
Enum values:
Individual
Collective
Example: Collective
legal_regimeLegal regime of the place
Enum values:
MonoPropriete
Copropriete
Example: Copropriete
created_atupdated_atCreate place
POST
https://api.faireplace.com/api
/places
Create place › Request Body
nametype_idlegislative_zone_idowner_idcountrystreet_namepostal_codecityplace_categorylegal_regimeaddress_complementstreet_numberlocalitypostal_boxlatitudelongitudedescriptiondigicodenumber_of_floorconstruction_daterenovation_dateCreate place › Responses
Created
idnamecountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxlatitudelongitudedescriptiontype_idlegislative_zone_iddigicodenumber_of_floorowner_idprevious_owner_idconstruction_daterenovation_dateplace_categoryPlace category (individual or collective)
Enum values:
Individual
Collective
Example: Collective
legal_regimeLegal regime of the place
Enum values:
MonoPropriete
Copropriete
Example: Copropriete
created_atupdated_atGet place
GET
https://api.faireplace.com/api
/places/{id}
path Parameters
idGet place › Responses
OK
idnamecountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxlatitudelongitudedescriptiontype_idlegislative_zone_iddigicodenumber_of_floorowner_idprevious_owner_idconstruction_daterenovation_dateplace_categoryPlace category (individual or collective)
Enum values:
Individual
Collective
Example: Collective
legal_regimeLegal regime of the place
Enum values:
MonoPropriete
Copropriete
Example: Copropriete
created_atupdated_atUpdate place
PUT
https://api.faireplace.com/api
/places/{id}
path Parameters
idUpdate place › Request Body
Data for updating an existing place.
**Update behavior for optional fields**:
- **Field absent**: the existing value is preserved (no modification)
- **Field present with `null`**: the value is removed (set to NULL in the database)
- **Field present with a value**: the value is updated
**Fields affected by this behavior**:
- `address_complement`: can be set to `null` to remove the value
- `street_number`: can be set to `null` to remove the value
- `locality`: can be set to `null` to remove the value
- `postal_box`: can be set to `null` to remove the value
- `latitude`: can be set to `null` to remove the value
- `longitude`: can be set to `null` to remove the value
**Fields assigned directly (can already be set to null)**:
- `description`, `digicode`, `number_of_floor`, `renovation_date`
namecountryaddress_complementAddress complement.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)- String: the value is updated
street_numberStreet number.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)- String: the value is updated
street_namelocalityLocality.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)- String: the value is updated
postal_codecitypostal_boxPostal box.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)- String: the value is updated
latitudeGPS latitude.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)- Number: the value is updated
longitudeGPS longitude.
Update behavior:
- Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)- Number: the value is updated
descriptiontype_idlegislative_zone_iddigicodenumber_of_floorplace_categoryPlace category (individual or collective)
Enum values:
Individual
Collective
Example: Collective
legal_regimeLegal regime of the place
Enum values:
MonoPropriete
Copropriete
Example: Copropriete
renovation_dateUpdate place › Responses
OK
idnamecountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxlatitudelongitudedescriptiontype_idlegislative_zone_iddigicodenumber_of_floorowner_idprevious_owner_idconstruction_daterenovation_dateplace_categoryPlace category (individual or collective)
Enum values:
Individual
Collective
Example: Collective
legal_regimeLegal regime of the place
Enum values:
MonoPropriete
Copropriete
Example: Copropriete
created_atupdated_atList place services
GET
https://api.faireplace.com/api
/places/{id}/services
path Parameters
idList place services › Responses
OK
object[]
idplace_idservice_idnamedescriptionis_chargeablecategory_idspace_typeSpace type for place services
Enum values:
INDOOR_COMMON
OUTDOOR_COMMON
PRIVATE
TECHNICAL
GARDEN
PARKING
TELECOM_SERVICES
Example: INDOOR_COMMON
default_distribution_key_idcreated_at