Endpoint Examples
- GETListe l'ensemble des biens d'un établissement
- GETLister les annonces actives
- GETDétails d'un bien
- GETTous les biens vendus
- POSTCréer un bien
- GETSupprimer un bien
- POSTModifier un bien
- POSTAjouter une photo à un bien
- DELSupprimer une photo d'un bien
- POSTModifier une chambre dans un bien
- POSTAffecter un commercial au bien
- DELRetirer un commercial du bien
- GETTracking de vues/partages
- GETCandidatures
- GETVisites
- GETSso
Endpoint Examples
Liste l'ensemble des biens d'un établissement
GET
/
properties
/
{etablissementId}
Copy
curl --request GET \
--url https://flatbay.fr/fr/api/properties/{etablissementId}
Copy
[
{
"id": 123,
"name": "<string>",
"userId": 123,
"address": "<string>",
"cp": "<string>",
"city": "<string>",
"lat": 123,
"description": "<string>",
"surface": 123,
"ascenseur": "<string>",
"meuble": true,
"balcon": true,
"nbFree": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"country": "<string>",
"lng": 123,
"type": 123,
"etage": "<string>",
"nbRoom": "<string>",
"nbDouche": "<string>",
"nbWc": "<string>",
"loyer": "<string>",
"depot": "<string>",
"charge": "<string>",
"chauffage": "<string>",
"electricite": "<string>",
"coloc": "<string>",
"start": "<string>",
"startRoom": "<string>",
"embed": "<string>",
"percent": "<string>",
"nbPiece": "<string>",
"gardien": "<string>",
"internet": "<string>",
"terrasse": "<string>",
"parking": "<string>",
"cave": "<string>",
"dpe": "<string>",
"lot": "<string>",
"public": "<string>",
"phone": "<string>",
"email": "<string>",
"colocOnly": "<string>",
"ges": "<string>",
"jardin": "<string>",
"showPhone": "<string>",
"minLoyer": "<string>",
"minCharge": "<string>",
"etablissementId": "<string>",
"frais": "<string>",
"fraisRoom": "<string>",
"pinel": "<string>",
"metro": "<string>",
"askVisite": "<string>",
"eauchaude": "<string>",
"eaufroide": "<string>",
"entretien": "<string>",
"eautype": "<string>",
"chauffagetype": "<string>",
"needpermisdelouerDetails": "<string>",
"needpermisdelouer": true,
"velo": "<string>",
"flatsy": "<string>",
"flatsyId": "<string>",
"flatsyStaffed": "<string>",
"nbEtage": "<string>",
"keyInfo": "<string>",
"keyDate": "<string>",
"ubiflow": "<string>",
"tenantPhone": "<string>",
"flatsyAgentName": "<string>",
"flatsyAgentPhone": "<string>",
"minDepot": "<string>",
"periclesId": "<string>",
"rentsellType": "<string>",
"fraisType": "<string>",
"prix": "<string>",
"foncier": "<string>",
"flatsyAgentPicture": "<string>",
"video": "<string>",
"facebook_mp_rentals": "<string>",
"lacartedescolocs": "<string>",
"getkey": true,
"agogoimmo": true,
"insoon_eb": true,
"lbc_aval": true,
"wizi": true,
"leboncoin_immo": true,
"vitrine_media": true,
"fwf_website": true,
"logic_immo": true,
"seloger": true,
"immo_square": true,
"explorimmo_v2": true,
"horiz_io": true,
"immostreet": true,
"fnaim": true,
"settlesweet": true,
"superimmo": true,
"ouestfrance": true,
"meilleursagents": true,
"garantme": true,
"etreproprio": true,
"alentoor": true,
"ornox": true,
"avenuedesdom": true,
"wymmo": true,
"goflint": true,
"trovit": true,
"toutvendre": true,
"vizzit": true,
"desactivateAlertAt": "<string>",
"flatsyKey": "<string>",
"landlordPhone": "<string>",
"tenantDispo": "<string>",
"tenantName": "<string>",
"landlordName": "<string>",
"flatsyDisable": "<string>",
"flatsyAutoAccept": "<string>",
"entretienJardin": "<string>",
"entretienChaudiere": "<string>",
"ordures": "<string>",
"menage": "<string>",
"risque": "<string>",
"bailType": "<string>",
"box": "<string>",
"piscine": "<string>",
"sport": "<string>",
"cinema": "<string>",
"type2": "<string>",
"construction": "<string>",
"tenantDispoEnd": "<string>",
"gli": "<string>",
"zoneId": "<string>",
"checkandvisitId": "<string>",
"maxLoyer": "<string>",
"maxCharge": "<string>",
"maxDepot": "<string>",
"digicode": "<string>",
"batiment": "<string>",
"escalier": "<string>",
"porte": "<string>",
"compteurElec": "<string>",
"compteurElecId": "<string>",
"compteurGaz": "<string>",
"compteurEauChaude": "<string>",
"compteurEauFroide": "<string>",
"compteurThermique": "<string>",
"caveLocation": "<string>",
"parkingLocation": "<string>",
"archive": "<string>",
"plaque": "<string>",
"four": "<string>",
"microonde": "<string>",
"frigo": "<string>",
"laveLinge": "<string>",
"secheLinge": "<string>",
"laveVaisselle": "<string>",
"cafetiere": "<string>",
"tv": "<string>",
"dbOpen": "<string>",
"dbClose": "<string>",
"hauteur": "<string>",
"exposition": "<string>",
"traversant": "<string>",
"fibre": "<string>",
"jacuzzi": "<string>",
"hammam": "<string>",
"sauna": "<string>",
"clim": "<string>",
"travaux": "<string>",
"ravalementDate": "<string>",
"refectionDate": "<string>",
"travauxDesc": "<string>",
"vitrage": "<string>",
"grillePain": "<string>",
"aspirateur": "<string>",
"bouilloire": "<string>",
"hotte": "<string>",
"vaisselle": "<string>",
"linge": "<string>",
"arriveeEau": "<string>",
"boxLocation": "<string>",
"refectionCommuneDate": "<string>",
"codeWifi": "<string>",
"disjoncteur": "<string>",
"boiteAuxLettres": "<string>",
"poubelles": "<string>",
"bailDuration": "<string>",
"terrainUsage": "<string>",
"terrainViable": "<string>",
"nbLots": "<string>",
"pmr": "<string>",
"longueur": "<string>",
"largeur": "<string>",
"sousSol": "<string>",
"vitrine": "<string>",
"cuisine": "<string>",
"publicEnd": "<string>",
"bailRight": "<string>",
"koliving": "<string>",
"commentLocation": "<string>",
"miloctav": "<string>",
"encadrement": "<string>",
"encadrementMin": "<string>",
"encadrementMax": "<string>",
"encadrementMinm": "<string>",
"encadrementMaxm": "<string>",
"occupe": "<string>",
"nbLotsCoproperty": "<string>",
"courtProceeding": "<string>",
"groupeId": "<string>",
"prospect": "<string>",
"extraction": "<string>",
"miseEnLoc": "<string>",
"livraison": "<string>",
"needMeuble": "<string>",
"loyerSouhaite": "<string>",
"loyerIdea": "<string>",
"dejaLoue": "<string>",
"surfaceJardin": "<string>",
"surfaceTerrain": "<string>",
"surfaceTerrasse": "<string>",
"surfaceBalcon": "<string>",
"etatGeneral": "<string>",
"parkingNumber": "<string>",
"garageNumber": "<string>",
"valuationValue": "<string>",
"valuationRangeLower": "<string>",
"valuationRangeUpper": "<string>",
"valuationConfidence": "<string>",
"flatsyStart": "<string>",
"infoColoc": "<string>",
"jinka": "<string>",
"embed2": "<string>",
"appartoo": "<string>",
"syndicName": "<string>",
"syndicUrl": "<string>",
"syndicAccount": "<string>",
"syndicPassword": "<string>",
"syndicDesc": "<string>",
"syndicEmail": "<string>",
"syndicTel": "<string>",
"syndicAddress": "<string>",
"syndicCp": "<string>",
"syndicCity": "<string>",
"syndicCountry": "<string>",
"syndicLng": "<string>",
"syndicLat": "<string>",
"offmarket": true,
"addresscache": "<string>",
"partageurDossierVenteId": "<string>",
"notifDossierVente": "<string>",
"notifPublicationProp": "<string>",
"notifPublicationPropAt": "<string>",
"sinch": "<string>",
"sinchphone": "<string>",
"relanceProprio": "<string>",
"relanceProprioFrequence": "<string>",
"relanceProprioNbMax": "<string>",
"relanceProprioNb": "<string>",
"relanceProprioAt": "<string>",
"diagnostic": "<string>",
"dossierVenteOtherDocs": "<string>",
"edlHonoraire": "<string>",
"status": "<string>",
"emergency": "<string>",
"nbProspect": "<string>",
"nbCandidate": "<string>",
"miloctavAt": "<string>",
"nbCandidateDemande": "<string>",
"nbCandidateOk": "<string>",
"nbCandidateMaybe": "<string>",
"nbOpen": "<string>",
"nbCandidateRelance1": "<string>",
"nbCandidateRelance2": "<string>",
"nbProspectRelance1": "<string>",
"nbProspectRelance2": "<string>",
"nbIsSmartLead": "<string>",
"nbIsSmartLeadRelance1": "<string>",
"nbIsSmartLeadRelance2": "<string>",
"valuationError": "<string>",
"valuationDate": "<string>",
"smartlead": "<string>",
"needRefreshCounters": "<string>",
"nbCandidateNotInSearch": "<string>",
"nbProspectDemande": "<string>",
"nbProspectMaybe": "<string>",
"nbProspectOk": "<string>",
"nbProspectNotInSearch": "<string>",
"nbIsSmartLeadMaybe": "<string>",
"nbIsSmartLeadOk": "<string>",
"nbIsSmartLeadNotInSearch": "<string>",
"energyBillMin": "<string>",
"energyBillMax": "<string>",
"honorairesCalcul": "<string>",
"percentPrix": "<string>",
"nbDetailDouche": "<string>",
"nbDetailBaignoire": "<string>",
"vueExcept": "<string>",
"surfaceTerrainBatiInclus": "<string>",
"dpeAt": "<string>",
"surfaceSousSol": "<string>",
"residenceType": "<string>",
"sellPlanned": "<string>",
"meansToSell": "<string>",
"valuationValueCustom": "<string>",
"valuationRangeLowerCustom": "<string>",
"valuationRangeUpperCustom": "<string>",
"valuationDateCustom": "<string>",
"fraisLocationBailleur": "<string>",
"fraisLocationBailleurPerM2": "<string>",
"fraisLocationBailleurApplicable": "<string>",
"percentRemise": "<string>",
"edlHonoraireBailleur": "<string>",
"edlHonoraireBailleurPerM2": "<string>",
"cheminee": "<string>",
"tennis": "<string>",
"barbecue": "<string>",
"pingpong": "<string>",
"interphone": "<string>",
"vueMer": "<string>",
"bienici": "<string>",
"favori": "<string>",
"etablissementName": "<string>",
"roomId": "<string>",
"roomName": "<string>",
"roomLoyer": "<string>",
"roomCharge": "<string>",
"roomDepot": "<string>",
"roomStart": "<string>",
"distance": "<string>",
"dpeGesLetter": "A",
"dpeLetter": "A",
"gesLetter": "A",
"inseeCode": "<string>",
"selledAt": "2023-12-25",
"finalHonorairesVenteTTC": 123,
"finalprixVenteHonoInclus": 123,
"visiteUrl": "<string>",
"documents": [
{
"id": 123,
"type": "document.type.propertyPrincipal",
"url": "<string>"
}
],
"mandats": [
{
"numberOfMandat": "<string>",
"type": "mandat.type.exclusif",
"registre": "mandat.registre.location",
"status": "mandat.status.encours",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"cancel": true,
"cancelAt": "2023-11-07T05:31:56Z"
}
]
}
]
Copy
/api/properties/:etablissementId?apiKey=xxxxx
Path Parameters
Identifiant d'un établissement
Available options:
1
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
Example:
1
Query Parameters
Mot de passe pour l'accès sécurisé
Example:
"api_key_here"
Response
200
application/json
création effectué
The response is of type object[]
.
Copy
curl --request GET \
--url https://flatbay.fr/fr/api/properties/{etablissementId}
Copy
[
{
"id": 123,
"name": "<string>",
"userId": 123,
"address": "<string>",
"cp": "<string>",
"city": "<string>",
"lat": 123,
"description": "<string>",
"surface": 123,
"ascenseur": "<string>",
"meuble": true,
"balcon": true,
"nbFree": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"country": "<string>",
"lng": 123,
"type": 123,
"etage": "<string>",
"nbRoom": "<string>",
"nbDouche": "<string>",
"nbWc": "<string>",
"loyer": "<string>",
"depot": "<string>",
"charge": "<string>",
"chauffage": "<string>",
"electricite": "<string>",
"coloc": "<string>",
"start": "<string>",
"startRoom": "<string>",
"embed": "<string>",
"percent": "<string>",
"nbPiece": "<string>",
"gardien": "<string>",
"internet": "<string>",
"terrasse": "<string>",
"parking": "<string>",
"cave": "<string>",
"dpe": "<string>",
"lot": "<string>",
"public": "<string>",
"phone": "<string>",
"email": "<string>",
"colocOnly": "<string>",
"ges": "<string>",
"jardin": "<string>",
"showPhone": "<string>",
"minLoyer": "<string>",
"minCharge": "<string>",
"etablissementId": "<string>",
"frais": "<string>",
"fraisRoom": "<string>",
"pinel": "<string>",
"metro": "<string>",
"askVisite": "<string>",
"eauchaude": "<string>",
"eaufroide": "<string>",
"entretien": "<string>",
"eautype": "<string>",
"chauffagetype": "<string>",
"needpermisdelouerDetails": "<string>",
"needpermisdelouer": true,
"velo": "<string>",
"flatsy": "<string>",
"flatsyId": "<string>",
"flatsyStaffed": "<string>",
"nbEtage": "<string>",
"keyInfo": "<string>",
"keyDate": "<string>",
"ubiflow": "<string>",
"tenantPhone": "<string>",
"flatsyAgentName": "<string>",
"flatsyAgentPhone": "<string>",
"minDepot": "<string>",
"periclesId": "<string>",
"rentsellType": "<string>",
"fraisType": "<string>",
"prix": "<string>",
"foncier": "<string>",
"flatsyAgentPicture": "<string>",
"video": "<string>",
"facebook_mp_rentals": "<string>",
"lacartedescolocs": "<string>",
"getkey": true,
"agogoimmo": true,
"insoon_eb": true,
"lbc_aval": true,
"wizi": true,
"leboncoin_immo": true,
"vitrine_media": true,
"fwf_website": true,
"logic_immo": true,
"seloger": true,
"immo_square": true,
"explorimmo_v2": true,
"horiz_io": true,
"immostreet": true,
"fnaim": true,
"settlesweet": true,
"superimmo": true,
"ouestfrance": true,
"meilleursagents": true,
"garantme": true,
"etreproprio": true,
"alentoor": true,
"ornox": true,
"avenuedesdom": true,
"wymmo": true,
"goflint": true,
"trovit": true,
"toutvendre": true,
"vizzit": true,
"desactivateAlertAt": "<string>",
"flatsyKey": "<string>",
"landlordPhone": "<string>",
"tenantDispo": "<string>",
"tenantName": "<string>",
"landlordName": "<string>",
"flatsyDisable": "<string>",
"flatsyAutoAccept": "<string>",
"entretienJardin": "<string>",
"entretienChaudiere": "<string>",
"ordures": "<string>",
"menage": "<string>",
"risque": "<string>",
"bailType": "<string>",
"box": "<string>",
"piscine": "<string>",
"sport": "<string>",
"cinema": "<string>",
"type2": "<string>",
"construction": "<string>",
"tenantDispoEnd": "<string>",
"gli": "<string>",
"zoneId": "<string>",
"checkandvisitId": "<string>",
"maxLoyer": "<string>",
"maxCharge": "<string>",
"maxDepot": "<string>",
"digicode": "<string>",
"batiment": "<string>",
"escalier": "<string>",
"porte": "<string>",
"compteurElec": "<string>",
"compteurElecId": "<string>",
"compteurGaz": "<string>",
"compteurEauChaude": "<string>",
"compteurEauFroide": "<string>",
"compteurThermique": "<string>",
"caveLocation": "<string>",
"parkingLocation": "<string>",
"archive": "<string>",
"plaque": "<string>",
"four": "<string>",
"microonde": "<string>",
"frigo": "<string>",
"laveLinge": "<string>",
"secheLinge": "<string>",
"laveVaisselle": "<string>",
"cafetiere": "<string>",
"tv": "<string>",
"dbOpen": "<string>",
"dbClose": "<string>",
"hauteur": "<string>",
"exposition": "<string>",
"traversant": "<string>",
"fibre": "<string>",
"jacuzzi": "<string>",
"hammam": "<string>",
"sauna": "<string>",
"clim": "<string>",
"travaux": "<string>",
"ravalementDate": "<string>",
"refectionDate": "<string>",
"travauxDesc": "<string>",
"vitrage": "<string>",
"grillePain": "<string>",
"aspirateur": "<string>",
"bouilloire": "<string>",
"hotte": "<string>",
"vaisselle": "<string>",
"linge": "<string>",
"arriveeEau": "<string>",
"boxLocation": "<string>",
"refectionCommuneDate": "<string>",
"codeWifi": "<string>",
"disjoncteur": "<string>",
"boiteAuxLettres": "<string>",
"poubelles": "<string>",
"bailDuration": "<string>",
"terrainUsage": "<string>",
"terrainViable": "<string>",
"nbLots": "<string>",
"pmr": "<string>",
"longueur": "<string>",
"largeur": "<string>",
"sousSol": "<string>",
"vitrine": "<string>",
"cuisine": "<string>",
"publicEnd": "<string>",
"bailRight": "<string>",
"koliving": "<string>",
"commentLocation": "<string>",
"miloctav": "<string>",
"encadrement": "<string>",
"encadrementMin": "<string>",
"encadrementMax": "<string>",
"encadrementMinm": "<string>",
"encadrementMaxm": "<string>",
"occupe": "<string>",
"nbLotsCoproperty": "<string>",
"courtProceeding": "<string>",
"groupeId": "<string>",
"prospect": "<string>",
"extraction": "<string>",
"miseEnLoc": "<string>",
"livraison": "<string>",
"needMeuble": "<string>",
"loyerSouhaite": "<string>",
"loyerIdea": "<string>",
"dejaLoue": "<string>",
"surfaceJardin": "<string>",
"surfaceTerrain": "<string>",
"surfaceTerrasse": "<string>",
"surfaceBalcon": "<string>",
"etatGeneral": "<string>",
"parkingNumber": "<string>",
"garageNumber": "<string>",
"valuationValue": "<string>",
"valuationRangeLower": "<string>",
"valuationRangeUpper": "<string>",
"valuationConfidence": "<string>",
"flatsyStart": "<string>",
"infoColoc": "<string>",
"jinka": "<string>",
"embed2": "<string>",
"appartoo": "<string>",
"syndicName": "<string>",
"syndicUrl": "<string>",
"syndicAccount": "<string>",
"syndicPassword": "<string>",
"syndicDesc": "<string>",
"syndicEmail": "<string>",
"syndicTel": "<string>",
"syndicAddress": "<string>",
"syndicCp": "<string>",
"syndicCity": "<string>",
"syndicCountry": "<string>",
"syndicLng": "<string>",
"syndicLat": "<string>",
"offmarket": true,
"addresscache": "<string>",
"partageurDossierVenteId": "<string>",
"notifDossierVente": "<string>",
"notifPublicationProp": "<string>",
"notifPublicationPropAt": "<string>",
"sinch": "<string>",
"sinchphone": "<string>",
"relanceProprio": "<string>",
"relanceProprioFrequence": "<string>",
"relanceProprioNbMax": "<string>",
"relanceProprioNb": "<string>",
"relanceProprioAt": "<string>",
"diagnostic": "<string>",
"dossierVenteOtherDocs": "<string>",
"edlHonoraire": "<string>",
"status": "<string>",
"emergency": "<string>",
"nbProspect": "<string>",
"nbCandidate": "<string>",
"miloctavAt": "<string>",
"nbCandidateDemande": "<string>",
"nbCandidateOk": "<string>",
"nbCandidateMaybe": "<string>",
"nbOpen": "<string>",
"nbCandidateRelance1": "<string>",
"nbCandidateRelance2": "<string>",
"nbProspectRelance1": "<string>",
"nbProspectRelance2": "<string>",
"nbIsSmartLead": "<string>",
"nbIsSmartLeadRelance1": "<string>",
"nbIsSmartLeadRelance2": "<string>",
"valuationError": "<string>",
"valuationDate": "<string>",
"smartlead": "<string>",
"needRefreshCounters": "<string>",
"nbCandidateNotInSearch": "<string>",
"nbProspectDemande": "<string>",
"nbProspectMaybe": "<string>",
"nbProspectOk": "<string>",
"nbProspectNotInSearch": "<string>",
"nbIsSmartLeadMaybe": "<string>",
"nbIsSmartLeadOk": "<string>",
"nbIsSmartLeadNotInSearch": "<string>",
"energyBillMin": "<string>",
"energyBillMax": "<string>",
"honorairesCalcul": "<string>",
"percentPrix": "<string>",
"nbDetailDouche": "<string>",
"nbDetailBaignoire": "<string>",
"vueExcept": "<string>",
"surfaceTerrainBatiInclus": "<string>",
"dpeAt": "<string>",
"surfaceSousSol": "<string>",
"residenceType": "<string>",
"sellPlanned": "<string>",
"meansToSell": "<string>",
"valuationValueCustom": "<string>",
"valuationRangeLowerCustom": "<string>",
"valuationRangeUpperCustom": "<string>",
"valuationDateCustom": "<string>",
"fraisLocationBailleur": "<string>",
"fraisLocationBailleurPerM2": "<string>",
"fraisLocationBailleurApplicable": "<string>",
"percentRemise": "<string>",
"edlHonoraireBailleur": "<string>",
"edlHonoraireBailleurPerM2": "<string>",
"cheminee": "<string>",
"tennis": "<string>",
"barbecue": "<string>",
"pingpong": "<string>",
"interphone": "<string>",
"vueMer": "<string>",
"bienici": "<string>",
"favori": "<string>",
"etablissementName": "<string>",
"roomId": "<string>",
"roomName": "<string>",
"roomLoyer": "<string>",
"roomCharge": "<string>",
"roomDepot": "<string>",
"roomStart": "<string>",
"distance": "<string>",
"dpeGesLetter": "A",
"dpeLetter": "A",
"gesLetter": "A",
"inseeCode": "<string>",
"selledAt": "2023-12-25",
"finalHonorairesVenteTTC": 123,
"finalprixVenteHonoInclus": 123,
"visiteUrl": "<string>",
"documents": [
{
"id": 123,
"type": "document.type.propertyPrincipal",
"url": "<string>"
}
],
"mandats": [
{
"numberOfMandat": "<string>",
"type": "mandat.type.exclusif",
"registre": "mandat.registre.location",
"status": "mandat.status.encours",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"cancel": true,
"cancelAt": "2023-11-07T05:31:56Z"
}
]
}
]
Assistant
Responses are generated using AI and may contain mistakes.