cURL
curl --request GET \
--url https://flatbay.fr/fr/api/candidate/{id}import requests
url = "https://flatbay.fr/fr/api/candidate/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://flatbay.fr/fr/api/candidate/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flatbay.fr/fr/api/candidate/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://flatbay.fr/fr/api/candidate/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://flatbay.fr/fr/api/candidate/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flatbay.fr/fr/api/candidate/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"propertyId": "<string>",
"roomId": "<string>",
"authorId": "<string>",
"groupeId": "<string>",
"fromMarqueBlancheAt": "2023-12-25",
"fromFlatbayAt": "2023-12-25",
"description": "<string>",
"status": "candidate.status.waitrecover",
"lostReason": "candidate.lostReason.direct",
"statusAt": "2023-12-25",
"archive": true,
"rentsellType": "property.rentsellType.rent",
"endAt": "2023-12-25",
"prix": "<string>",
"apport": "<string>",
"condition": "candidate.condition.yes",
"type": "candidate.type.seul",
"koReason": "<string>",
"assistantStatus": "<string>",
"assistantReason": "<string>",
"assistantAt": "<string>",
"assistantNbRelance": "<string>",
"addManual": "<string>",
"situationPinel": "candidate.situationPinel.seul",
"refusedReason": "<string>",
"refusedReasonOther": "<string>",
"n2": "<string>",
"pret": "<string>",
"urbanisme": "<string>",
"preemption": "<string>",
"hypotheque": "<string>",
"destination": "<string>",
"construire": "<string>",
"travaux": "<string>",
"amenagement": "<string>",
"lotir": "<string>",
"autre": "<string>",
"pretEnd": "<string>",
"pretTaux": "<string>",
"autreDescription": "<string>",
"waitingDeletion": "<string>",
"waitingDeletionAt": "<string>",
"garantmeId": "<string>",
"gliStatus": "candidate.gliStatus.pending",
"gliMessage": "<string>",
"gliDate": "<string>",
"gliSentDate": "<string>",
"createdAt": "2023-12-25",
"updatedAt": "2023-12-25",
"candidate": true,
"portail": "<string>",
"portailAt": "2023-12-25",
"visiteAt": "2023-12-25",
"visitequeueAt": "<string>",
"chatAt": "<string>",
"smartLeadAt": "<string>",
"isSmartLead": "<string>",
"gestion": "0",
"rentMan": "<string>",
"isMeuble": "<string>",
"source": "candidate.source.formesti",
"estimation": "<string>",
"needContact": "<string>",
"nbBien": "<string>",
"comments": "<string>",
"value": "<string>",
"isProprio": "<string>",
"reasonOfEstimation": "candidate.reasonOfEstimation.wishSell",
"etablissementId": 1,
"pinel": false,
"address": "<string>",
"cp": "<string>",
"city": "<string>",
"lot": "<string>",
"candidatePercent": 123,
"candidateRevenus": 123,
"nbPiece": 123,
"commerciaux": [
{
"civility": "user.civility.m",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>"
}
],
"users": [
{
"id": 123,
"civility": "user.civility.m",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"birthDate": "2023-12-25",
"address": "<string>",
"city": "<string>",
"optinStart": "2023-12-25",
"optinEnd": "2023-12-25",
"candidateId": 123,
"userId": 123,
"propertyId": 123,
"visitedQueueAt": "2023-12-25",
"visitedAt": "2023-12-25",
"validate": true,
"createdAt": true,
"updatedAt": true,
"documents": [
{
"id": 123,
"name": "<string>",
"type": "document.type.identite => Pièce d'identité",
"status": "validationDocument.status.conf => Conforme",
"statusUpdateAt": "2023-12-25",
"validatingAgentLastName": "<string>",
"validatingAgentFirstName": "<string>"
}
],
"garants": [
{
"garantId": 123,
"civility": "user.civility.m",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"birthDate": "2023-12-25",
"address": "<string>",
"city": "<string>",
"garantType": "user.garant.organisme",
"organismeName": "Visale",
"montantGaranti": 123,
"documents": [
{
"id": 123,
"name": "<string>",
"type": "document.type.identite => Pièce d'identité",
"status": "validationDocument.status.conf => Conforme",
"statusUpdateAt": "2023-12-25",
"validatingAgentLastName": "<string>",
"validatingAgentFirstName": "<string>"
}
]
}
]
}
]
}{
"error": "<string>"
}Endpoint Examples
Candidature
Route de récupération
GET
/
candidate
/
{id}
cURL
curl --request GET \
--url https://flatbay.fr/fr/api/candidate/{id}import requests
url = "https://flatbay.fr/fr/api/candidate/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://flatbay.fr/fr/api/candidate/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flatbay.fr/fr/api/candidate/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://flatbay.fr/fr/api/candidate/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://flatbay.fr/fr/api/candidate/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flatbay.fr/fr/api/candidate/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"propertyId": "<string>",
"roomId": "<string>",
"authorId": "<string>",
"groupeId": "<string>",
"fromMarqueBlancheAt": "2023-12-25",
"fromFlatbayAt": "2023-12-25",
"description": "<string>",
"status": "candidate.status.waitrecover",
"lostReason": "candidate.lostReason.direct",
"statusAt": "2023-12-25",
"archive": true,
"rentsellType": "property.rentsellType.rent",
"endAt": "2023-12-25",
"prix": "<string>",
"apport": "<string>",
"condition": "candidate.condition.yes",
"type": "candidate.type.seul",
"koReason": "<string>",
"assistantStatus": "<string>",
"assistantReason": "<string>",
"assistantAt": "<string>",
"assistantNbRelance": "<string>",
"addManual": "<string>",
"situationPinel": "candidate.situationPinel.seul",
"refusedReason": "<string>",
"refusedReasonOther": "<string>",
"n2": "<string>",
"pret": "<string>",
"urbanisme": "<string>",
"preemption": "<string>",
"hypotheque": "<string>",
"destination": "<string>",
"construire": "<string>",
"travaux": "<string>",
"amenagement": "<string>",
"lotir": "<string>",
"autre": "<string>",
"pretEnd": "<string>",
"pretTaux": "<string>",
"autreDescription": "<string>",
"waitingDeletion": "<string>",
"waitingDeletionAt": "<string>",
"garantmeId": "<string>",
"gliStatus": "candidate.gliStatus.pending",
"gliMessage": "<string>",
"gliDate": "<string>",
"gliSentDate": "<string>",
"createdAt": "2023-12-25",
"updatedAt": "2023-12-25",
"candidate": true,
"portail": "<string>",
"portailAt": "2023-12-25",
"visiteAt": "2023-12-25",
"visitequeueAt": "<string>",
"chatAt": "<string>",
"smartLeadAt": "<string>",
"isSmartLead": "<string>",
"gestion": "0",
"rentMan": "<string>",
"isMeuble": "<string>",
"source": "candidate.source.formesti",
"estimation": "<string>",
"needContact": "<string>",
"nbBien": "<string>",
"comments": "<string>",
"value": "<string>",
"isProprio": "<string>",
"reasonOfEstimation": "candidate.reasonOfEstimation.wishSell",
"etablissementId": 1,
"pinel": false,
"address": "<string>",
"cp": "<string>",
"city": "<string>",
"lot": "<string>",
"candidatePercent": 123,
"candidateRevenus": 123,
"nbPiece": 123,
"commerciaux": [
{
"civility": "user.civility.m",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>"
}
],
"users": [
{
"id": 123,
"civility": "user.civility.m",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"birthDate": "2023-12-25",
"address": "<string>",
"city": "<string>",
"optinStart": "2023-12-25",
"optinEnd": "2023-12-25",
"candidateId": 123,
"userId": 123,
"propertyId": 123,
"visitedQueueAt": "2023-12-25",
"visitedAt": "2023-12-25",
"validate": true,
"createdAt": true,
"updatedAt": true,
"documents": [
{
"id": 123,
"name": "<string>",
"type": "document.type.identite => Pièce d'identité",
"status": "validationDocument.status.conf => Conforme",
"statusUpdateAt": "2023-12-25",
"validatingAgentLastName": "<string>",
"validatingAgentFirstName": "<string>"
}
],
"garants": [
{
"garantId": 123,
"civility": "user.civility.m",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"birthDate": "2023-12-25",
"address": "<string>",
"city": "<string>",
"garantType": "user.garant.organisme",
"organismeName": "Visale",
"montantGaranti": 123,
"documents": [
{
"id": 123,
"name": "<string>",
"type": "document.type.identite => Pièce d'identité",
"status": "validationDocument.status.conf => Conforme",
"statusUpdateAt": "2023-12-25",
"validatingAgentLastName": "<string>",
"validatingAgentFirstName": "<string>"
}
]
}
]
}
]
}{
"error": "<string>"
}/api/candidate/:id?apiKey=xxxxx
{baseurl}/{locale}/document/picture/{document.id}?apiKey=xxxx
Path Parameters
Query Parameters
Pour récupérer les leads qui ont ce statut
Available options:
candidate.status.waitrecover => Réévaluation en cours, candidate.status.recover => Dossier réévalué, candidate.status.demande => Non traitée, candidate.status.maybe => À l'étude, candidate.status.ok => Acceptée, candidate.status.ko => Refusée, candidate.status.relance1 => Relancé une fois, candidate.status.relance2 => Relancé deux fois, candidate.status.cancel => Désistement, candidate.status.contacte => Prospect contacté, candidate.status.estimEnvoye => Estimation envoyée, candidate.status.attDoc => En attente de document, candidate.status.mandatEnvoye => Mandat envoyé, candidate.status.mandatSigne => Mandat signé, candidate.status.pasInterr => Pas interéssé, candidate.status.lost => Perdu, candidate.status.notinsearch => Ne recherche Plus Example:
"candidate.status.ok => Acceptée"
Response
Réponse ok
Statut de la candidature
Available options:
candidate.status.waitrecover, candidate.status.recover, candidate.status.demande, candidate.status.maybe, candidate.status.ok, candidate.status.ko, candidate.status.relance1, candidate.status.relance2, candidate.status.cancel, candidate.status.contacte, candidate.status.estimEnvoye, candidate.status.attDoc, candidate.status.mandatEnvoye, candidate.status.mandatSigne, candidate.status.pasInterr, candidate.status.lost, candidate.status.notinsearch Raison de la perte de la candidature (demande de gestion/vente)
Available options:
candidate.lostReason.direct, candidate.lostReason.outofarea, candidate.lostReason.notresponse, candidate.lostReason.otheretablissement, candidate.lostReason.treatmenttoolong, candidate.lostReason.pricetoohigh, candidate.lostReason.notActuality Condition(s) suspensive(s)
Available options:
candidate.condition.yes, candidate.condition.no, candidate.condition.pret, candidate.condition.urbanisme, candidate.condition.preemption, candidate.condition.hypotheque, candidate.condition.destination, candidate.condition.construire, candidate.condition.travaux, candidate.condition.amenagement, candidate.condition.lotir, candidate.condition.autre, candidate.condition.pretEnd, candidate.condition.pretTaux 
