Candidatures
Route de récupération des leads (prospects/candidats) d’un établissement ou du groupe. Par defaut la route renvoie uniquement les leads créés ou mis à jour durant les dernieres 24H (le query from permet d’ajuster ce comportement)
Filtre temporel
Le filtre porte surupdatedAt des candidatures. La fenêtre end - start est plafonnée à 31 jours (1 mois) ; au-delà l’API renvoie 400 RANGE_TOO_LARGE. Pour récupérer un historique plus long, itérez par tranches.
| Paramètre | Défaut | Description |
|---|---|---|
start | end - 24h | Date ISO 8601, borne basse sur updatedAt. |
end | maintenant | Date ISO 8601, borne haute sur updatedAt. |
from | — | Déprécié. Alias historique de start (avec end = maintenant). Conservé pour rétrocompatibilité. |
Exemple : pagination par tranches de 1 mois
Query Parameters
Mot de passe pour l'accès sécurisé
"api_key_here"
Pour récupérer les leads qui ont ce statut
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 "candidate.status.ok => Acceptée"
Identifiant d'un établissement
1, 3, 4, 5, 6, 7, 8, 9, 10 1
Date ISO 8601, borne basse sur updatedAt. Défaut : end - 24h.
"2025-01-01T00:00:00"
Date ISO 8601, borne haute sur updatedAt. Défaut : maintenant. La fenêtre end - start ne peut pas dépasser 31 jours, sinon l'API renvoie 400 RANGE_TOO_LARGE.
"2025-03-31T23:59:59"
Déprécié. Alias historique de start (end = maintenant). Préférer start/end.
"2022-05-30"
Response
Réponse ok
Id de la candidature
Id de la propriété de la candidature
Id de la room si c'est une colocation avec un bail individuel
Id du user autheur de la candidature
Pour le mandant, le groupe auxquel se rattache cette candidature (demande de gestion/vente)
candidate.fromMarqueBlancheAt
candidate.fromFlatbayAt
candidate.description
Statut de la candidature
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)
candidate.lostReason.direct, candidate.lostReason.outofarea, candidate.lostReason.notresponse, candidate.lostReason.otheretablissement, candidate.lostReason.treatmenttoolong, candidate.lostReason.pricetoohigh, candidate.lostReason.notActuality candidate.statusAt
La candidature est t-elle archivée ?
Type de la candidature (candidature de vente/location)
property.rentsellType.rent, property.rentsellType.sell candidate.endAt
Montant de l'offre en €
Montant de l'apport en €
Condition(s) suspensive(s)
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 Type de la candidature (seul/couple/groupe)
candidate.type.seul, candidate.type.couple, candidate.type.groupe candidate.koReason
candidate.assistantStatus
candidate.assistantReason
candidate.assistantAt
candidate.assistantNbRelance
candidate.addManual
Nombre de personnes dans le foyer fiscal
candidate.situationPinel.seul, candidate.situationPinel.couple, candidate.situationPinel.p1, candidate.situationPinel.p2, candidate.situationPinel.p3, candidate.situationPinel.p4, candidate.situationPinel.pp candidate.refusedReason
candidate.refusedReasonOther
candidate.n2
candidate.pret
candidate.urbanisme
candidate.preemption
candidate.hypotheque
candidate.destination
candidate.construire
candidate.travaux
candidate.amenagement
candidate.lotir
candidate.autre
candidate.pretEnd
candidate.pretTaux
candidate.autreDescription
candidate.waitingDeletion
candidate.waitingDeletionAt
candidate.garantmeId
candidate.gliStatus
candidate.gliStatus.pending, candidate.gliStatus.need_data, candidate.gliStatus.ok, candidate.gliStatus.ko candidate.gliMessage
candidate.gliDate
candidate.gliSentDate
Date de création de la candidature
Date de mise à jour de la candidature
Candidature/Offre déposée. 1 pour oui sinon 0. 0 Correspond donc à un prospect qui n'a pas candidaté ou déposé d'offre
Si la candidatuire vient d'un portail
Date de la création venue du portail
Si la candidature vient d'une visite
candidate.visitequeueAt
candidate.chatAt
candidate.smartLeadAt
candidate.isSmartLead
Si 1, c'est une candidature de mandant (demande de gestion/vente)
0, 1 candidate.rentMan
candidate.isMeuble
Source
candidate.source.formesti, candidate.source.formGest, candidate.source.gbc, candidate.source.caidf, candidate.source.flatbay candidate.estimation
Souhaite être contacté
candidate.nbBien
Vous pouvez laisser ici un message à l'attention de l'agence ou du propriétaire (facultatif)
Montant
Est-t'il proprietaire de ce bien ?
Pour quelle raison estimez-vous ce bien
candidate.reasonOfEstimation.wishSell, candidate.reasonOfEstimation.wishRent, candidate.reasonOfEstimation.isSale, candidate.reasonOfEstimation.iamlocataire, candidate.reasonOfEstimation.info Identifiant d'un établissement
1, 3, 4, 5, 6, 7, 8, 9, 10 1
Propriété Pinel/PLS (dispositif fiscal pour les logements achetés neufs)
false, true Adresse du bien pour lequel la candidature a été créée
Code postal du bien pour lequel la candidature a été créée
Ville du bien pour lequel la candidature a été créée
Référence interne du bien ou typologie dans le cadre d'une résidence étudiante. Ces valeurs sont uniques pour tous les biens de cet établissement
Moyenne des pourcentages de complétion des dossiers des candidats composant cette candidature
Moyenne des revenus des candidats composant cette candidature
Nombre de pièce(s) ou typologie
Tableau des commerciaux en charges de cette candidature
Tableau des leads qui constituent la candidature

