Récupérer les candidats

Vous pouvez récupérer les candidats grâce à l'API.

Requête

Cette méthode permet de rechercher un (ou plusieurs) candidats :

POST /company/{companyID}/search/applicants

Paramètres

Paramètre	In	Type	Obligatoire	Description	Exemple
companyId	path	string	✔️	Identifiant de l'entreprise	Wy3EOp2NP3p1KMq8
firstname	payload	string		firstname du candidat	John
lastname	payload	string		lastname du candidat	Doe
email	payload	string		email du candidat	john.doe@mail.fr
hired	payload	boolean		Le candidat est-il recruté ou non ?	true
column	payload	string		title de la colonne dans laquelle se trouve le candidat	Entretien RH
start	payload	string		Date au format MM/JJ/AA pour rechercher les candidats créés à partir d'une date donnée	11/15/22
end	payload	string		Date au format MM/JJ/AA pour rechercher les candidats créés avant une date donnée"	12/25/22
start_update	payload	string		Date au format MM/JJ/AA pour rechercher les candidats modifiés à partir d'une date donnée	11/15/22
end_update	payload	string		Date au format MM/JJ/AA pour rechercher les candidats modifiés avant une date donnée	12/25/22
company	payload	string		Permet de rechercher sur plusieurs entreprises pour les multicomptes
vacancy	payload	string		id de l'offre dans laquelle se trouve le candidat	k5aMxpQoK7nGZ2Oz
phone	payload	string		téléphone du candidat	06 06 06 06 06

Exemples de requête

Nom

Requête cURL

curl -X POST https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/search/applicants
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'
    -d '{"lastname":"{nom}"}'

Email

Requête cURL

curl -X POST https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/search/applicants
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'
    -d '{"email":"{mail@mail.com}"}'

Recruté

Requête cURL

curl -X POST https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/search/applicants
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'
    -d '{"hired":"true"}'

Archivés

Requête cURL

curl -X POST https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/search/applicants
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'
    -d '{"status": 0}'

Depuis le 25/12/2021

Requête cURL

curl -X POST https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/search/applicants
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'
    -d '{"start":"12/25/21"}'

Entre le 01/01/2022 et le 10/01/2022

Requête cURL

curl -X POST https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/search/applicants
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'
    -d '{"start":"01/01/22", "end":"01/10/22"}'

Multicomptes

Requête cURL

curl -X POST https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/search/applicants
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'
    -d '{"hired":"true","company":"{company}"}'

Réponse

Name	Type	Description
applicant	string	Id du candidat
vacancy	string	Nom de l'offre sur laquelle il a postulé
column	string	Colonne dans laquelle est le candidat
vacancy_id	integer	Identifiant de l'offre
external_id	string	Id externe
status	integer	Statut du candidat (0: Archivé, 1: Actif)
score	integer	Score du candidat
hired	boolean	Le candidat est-il recruté ?
firstname	string	Prénom
lastname	string	Nom
email	string	Mail
phone	string	Téléphone
created_at	timestamp	Date de création du candidat (JJ/MM/AA)
updated_at	timestamp	Date de modification du candidat (JJ/MM/AA)
source	string	Source de la candidature
reason	string	Motif de recrutement ou de refus
import	boolean	Le candidat a t'il été importé ?
creator	string	Nom Prénom du membre qui a coopté le candidat
cv.key	string	Clé du CV
cv.extension	string	Extension du CV
urls	object	Urls du candidat

Exemple de réponse

Réponse type

[{
    "applicant": "BEjyY9lke8nZl7o2",
    "vacancy": " Commercial(e) - Paris - CDI ",
    "column": "Entretien RH",
    "vacancy_id": "1zj8Md6kD8nYZ70J",
    "external_id": "",
    "status": 1,
    "score": 90,
    "hired": false,
    "firstname": "michelle",
    "lastname": "dekerre",
    "email": "michelle.d@mail.com",
    "phone": "",
    "created_at": "15/11/24",
    "source": "Site carrière",
    "import": true,
    "cv": {
        "key": "candidates/2024/11/c18f5238-a774-4609-8d59-f022a8f781db/dekerre-michelle",
        "extension": "pdf"
    },
    "urls": {
        "linkedin": "michelle-dekerre-020222222",
        "twitter": "michelle_dekerre"
    }
}]

Archivé

[{
    "applicant": "2o7lZn8ekl9YyjEB",
    "vacancy": " Commercial(e) - Paris - CDI ",
    "column": "Entretien RH",
    "vacancy_id": "1zj8Md6kD8nYZ70J",
    "external_id": "",
    "status": 0,
    "score": 10,
    "hired": false,
    "firstname": "Joe",
    "lastname": "Seant",
    "email": "joe.seant@mail.com",
    "phone": "",
    "created_at": "15/11/24",
    "source": "Site carrière",
    "reason": "Manque d'expérience pour le poste",
    "import": true
}]