GET
/
candidate
/
{id}
cURL
curl --request GET \
  --url https://flatbay.fr/fr/api/candidate/{id}
{
  "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,
  "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>",
      "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>"
            }
          ]
        }
      ]
    }
  ]
}
/api/candidate/:id?apiKey=xxxxx
il faudra que l’equipe flatbay vous fournisse une clé d’api pour utiliser cette route. Cette route permet de récupérer les documents des candidats et des garants. 
{baseurl}/{locale}/document/picture/{document.id}?apiKey=xxxx

Path Parameters

​
id
enum<integer>
required

Id d'une candidature

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"

​
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

Response

200
application/json

Réponse ok

The response is of type object.