Candidatures

GET

candidates

curl --request GET \
  --url https://flatbay.fr/fr/api/candidates

[
  {
    "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>",
    "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": true,
    "address": "<string>",
    "cp": "<string>",
    "city": "<string>",
    "lot": "<string>",
    "candidatePercent": 123,
    "candidateRevenus": 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>",
        "candidateId": 123,
        "userId": 123,
        "propertyId": 123,
        "visitedQueueAt": "2023-12-25",
        "visitedAt": "2023-12-25",
        "validate": true,
        "createdAt": true,
        "updatedAt": true,
        "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
          }
        ]
      }
    ]
  }
]

/api/candidates?apiKey=xxxxx

il faudra que l’equipe flatbay vous fournisse une clé d’api pour utiliser cette route.

Query Parameters

apiKey

string

required

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

Example:

"api_key_here"

status

enum<string>

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"

etablissementId

enum<integer>

Identifiant d'un établissement

Available options:

1,

3,

4,

5,

6,

7,

8,

9,

10

Example:

1

from

string

Date depuis laquelle récupérer les leads

Example:

"2022-05-30T12:00:00"

Response

200

application/json

Réponse ok

string

Id de la candidature

propertyId

string

Id de la propriété de la candidature

roomId

string

Id de la room si c'est une colocation avec un bail individuel

authorId

string

Id du user autheur de la candidature

groupeId

string

Pour le mandant, le groupe auxquel se rattache cette candidature (demande de gestion/vente)

fromMarqueBlancheAt

string

candidate.fromMarqueBlancheAt

fromFlatbayAt

string

candidate.fromFlatbayAt

description

string

candidate.description

status

enum<string>

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

lostReason

enum<string>

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

statusAt

string

candidate.statusAt

archive

boolean

La candidature est t-elle archivée ?

rentsellType

enum<string>

Type de la candidature (candidature de vente/location)

Available options:

property.rentsellType.rent,

property.rentsellType.sell

endAt

string

candidate.endAt

prix

string

Montant de l'offre en €

apport

string

Montant de l'apport en €

condition

enum<string>

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

type

enum<string>

Type de la candidature (seul/couple/groupe)

Available options:

candidate.type.seul,

candidate.type.couple,

candidate.type.groupe

koReason

string

candidate.koReason

assistantStatus

string

candidate.assistantStatus

assistantReason

string

candidate.assistantReason

assistantAt

string

candidate.assistantAt

assistantNbRelance

string

candidate.assistantNbRelance

addManual

string

candidate.addManual

situationPinel

enum<string>

Nombre de personnes dans le foyer fiscal

Available options:

candidate.situationPinel.seul,

candidate.situationPinel.couple,

candidate.situationPinel.p1,

candidate.situationPinel.p2,

candidate.situationPinel.p3,

candidate.situationPinel.p4,

candidate.situationPinel.pp

refusedReason

string

candidate.refusedReason

refusedReasonOther

string

candidate.refusedReasonOther

string

candidate.n2

pret

string

candidate.pret

urbanisme

string

candidate.urbanisme

preemption

string

candidate.preemption

hypotheque

string

candidate.hypotheque

destination

string

candidate.destination

construire

string

candidate.construire

travaux

string

candidate.travaux

amenagement

string

candidate.amenagement

lotir

string

candidate.lotir

autre

string

candidate.autre

pretEnd

string

candidate.pretEnd

pretTaux

string

candidate.pretTaux

autreDescription

string

candidate.autreDescription

waitingDeletion

string

candidate.waitingDeletion

waitingDeletionAt

string

candidate.waitingDeletionAt

garantmeId

string

candidate.garantmeId

gliStatus

enum<string>

candidate.gliStatus

Available options:

candidate.gliStatus.pending,

candidate.gliStatus.need_data,

candidate.gliStatus.ok,

candidate.gliStatus.ko

gliMessage

string

candidate.gliMessage

gliDate

string

candidate.gliDate

gliSentDate

string

candidate.gliSentDate

createdAt

string

Date de création de la candidature

updatedAt

string

Date de mise à jour de la candidature

candidate

boolean

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

portail

string

Si la candidatuire vient d'un portail

portailAt

string

Date de la création venue du portail

visiteAt

string

Si la candidature vient d'une visite

visitequeueAt

string

candidate.visitequeueAt

chatAt

string

candidate.chatAt

smartLeadAt

string

candidate.smartLeadAt

isSmartLead

string

candidate.isSmartLead

gestion

enum<string>

Si 1, c'est une candidature de mandant (demande de gestion/vente)

rentMan

string

candidate.rentMan

isMeuble

string

candidate.isMeuble

source

enum<string>

Source

Available options:

candidate.source.formesti,

candidate.source.formGest,

candidate.source.gbc,

candidate.source.caidf,

candidate.source.flatbay

estimation

string

candidate.estimation

needContact

string

Souhaite être contacté

nbBien

string

candidate.nbBien

comments

string

Vous pouvez laisser ici un message à l'attention de l'agence ou du propriétaire (facultatif)

value

string

Montant

isProprio

string

Est-t'il proprietaire de ce bien ?

reasonOfEstimation

enum<string>

Pour quelle raison estimez-vous ce bien

Available options:

candidate.reasonOfEstimation.wishSell,

candidate.reasonOfEstimation.wishRent,

candidate.reasonOfEstimation.isSale,

candidate.reasonOfEstimation.iamlocataire,

candidate.reasonOfEstimation.info

etablissementId

enum<integer>

Identifiant d'un établissement

Available options:

1,

3,

4,

5,

6,

7,

8,

9,

10

Example:

1

pinel

boolean

Propriété Pinel/PLS (dispositif fiscal pour les logements achetés neufs)

address

string

Adresse du bien pour lequel la candidature a été créée

string

Code postal du bien pour lequel la candidature a été créée

city

string

Ville du bien pour lequel la candidature a été créée

lot

string

Référence interne du bien pour lequel la candidature a été créée

candidatePercent

number

Moyenne des pourcentages de complétion des dossiers des candidats composant cette candidature

candidateRevenus

number

Moyenne des revenus des candidats composant cette candidature

commerciaux

object[]

Tableau des commerciaux en charges de cette candidature

users

object[]

Tableau des leads qui constituent la candidature

users.id

number

Id du user candidat

users.civility

enum<string>

Civilité du commercial

Available options:

user.civility.m,

user.civility.mme,

user.civility.other

users.firstName

string

Prénom du commercial

users.lastName

string

Nom du commercial

users.email

string

Email du commercial

users.phone

string

Téléphone du commercial

users.birthDate

string

Date d'anniversaire du candidat

users.address

string

Adresse du candidat

users.city

string

Ville de l'adresse candidat

users.candidateId

number

Id de la candidature pour laquelle on référence ce candidat

users.userId

number

Id du user candidat

users.propertyId

number

Id du bien pour lequel ce candidat postule

users.visitedQueueAt

string

Date de mise en attente de visite de ce user candidat

users.visitedAt

string

Date de visite de ce candidat user

users.validate

boolean

Le user candidat a t-il validé son compte

users.createdAt

boolean

Date de création du candidat user

users.updatedAt

boolean

Date de mise à jour du candidat user

users.garants

object[]

Tableau des garants du candidat user

Tracking de vues/partages Visites

curl --request GET \
  --url https://flatbay.fr/fr/api/candidates

[
  {
    "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>",
    "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": true,
    "address": "<string>",
    "cp": "<string>",
    "city": "<string>",
    "lot": "<string>",
    "candidatePercent": 123,
    "candidateRevenus": 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>",
        "candidateId": 123,
        "userId": 123,
        "propertyId": 123,
        "visitedQueueAt": "2023-12-25",
        "visitedAt": "2023-12-25",
        "validate": true,
        "createdAt": true,
        "updatedAt": true,
        "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
          }
        ]
      }
    ]
  }
]

Endpoint Examples

Query Parameters

Response