GET
/
properties
/
{etablissementId}
curl --request GET \
  --url https://flatbay.fr/fr/api/properties/{etablissementId}
[
  {
    "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>",
    "seloger": "<string>",
    "video": "<string>",
    "facebook_mp_rentals": "<string>",
    "lacartedescolocs": "<string>",
    "leboncoin_immo": "<string>",
    "lbc_aval": "<string>",
    "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>",
    "logic_immo": "<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>",
    "wizi": "<string>",
    "insoon_eb": "<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>",
    "explorimmo_v2": "<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>",
    "immostreet": "<string>",
    "fnaim": "<string>",
    "offmarket": "<string>",
    "settlesweet": "<string>",
    "superimmo": "<string>",
    "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>",
    "ouestfrance": "<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>",
    "horiz_io": "<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>",
    "meilleursagents": "<string>",
    "etreproprio": "<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"
      }
    ]
  }
]
/api/properties/:etablissementId?apiKey=xxxxx

Path Parameters

id
enum<integer>
required

Identifiant d'un établissement

Available options:
1,
3,
4,
5,
6,
7,
8,
9,
10
Example:

1

Query Parameters

apiKey
string
required

Mot de passe pour l'accès sécurisé

Example:

"api_key_here"

Response

200
application/json
création effectué
id
number
name
string
userId
number
address
string

Présente si l'agent n'a pas caché l'adresse

cp
string
city
string
lat
number
description
string
surface
number
ascenseur
string
meuble
boolean
balcon
boolean
nbFree
string
createdAt
string
updatedAt
string
country
string
lng
number
type
number
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

Détails pour les villes avec permis de louer

needpermisdelouer
boolean

Ville avec permis de louer

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
seloger
string
video
string
facebook_mp_rentals
string
lacartedescolocs
string
leboncoin_immo
string
lbc_aval
string
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
logic_immo
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
wizi
string
insoon_eb
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
explorimmo_v2
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
immostreet
string
fnaim
string
offmarket
string
settlesweet
string
superimmo
string
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
ouestfrance
string
valuationError
string
valuationDate
string
smartlead
string
needRefreshCounters
string
nbProspectDemande
string
nbProspectMaybe
string
nbProspectOk
string
nbIsSmartLeadMaybe
string
nbIsSmartLeadOk
string
horiz_io
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
meilleursagents
string
etreproprio
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
enum<string>

Lettre globale du bilan DPE/GES

Available options:
A,
B,
C,
D,
E,
F,
G
dpeLetter
enum<string>
Available options:
A,
B,
C,
D,
E,
F,
G
gesLetter
enum<string>
Available options:
A,
B,
C,
D,
E,
F,
G
inseeCode
string

Code insee de la ville du bien

selledAt
string

Date de vente d'un bien

finalHonorairesVenteTTC
number

Total des honoraires finaux de vente pour un bien vendu

finalprixVenteHonoInclus
number

Prix de vente final pour un bien vendu

visiteUrl
string

URL pour une prise de visite pour ce bien (absent sur la route des biens vendus)

documents
object[]
mandats
object[]