Récupérer les messages

Vous pouvez récupérer les messages échangés avec un candidat grâce à l'API.

Requête

GET /company/{companyID}/applicant/{applicantID}/messages?fields=author,replied,mail,attachments,candidate

Paramètres

Paramètre	In	Type	Obligatoire	Description	Exemple
companyID	path	string	✔️	Identifiant de l'entreprise	0GjqBwprWAdArDl4
applicantID	path	string	✔️	id du candidat	V41QG9eja5pK6Xev
fields	query	string		Champs à afficher, séparés par une virgule	author,replied,mail,attachments,candidate

Exemples de requête

Requête cURL

curl -X GET 'https://api.flatchr.io/company/0GjNBwprWAdZrDl4/applicant/V41QG8eja5pK6XeV/messages?fields=author,replied,mail,attachments,candidate'
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'

Réponse

Name	Type	Description
id	integer	Identifiant du message
created_by	integer	Identifiant de l'auteur du message
created_at	timestamp	Date de création du message
auto	boolean	Le message était-il un message automatique ?
mail	mail	L'objet mail
delivered	boolean	Le message a t'il été délivré ?
delivered_at	timestamp	La date de livraison du mail
author	author	Auteur du message
candidate	candidate	Le candidat concerné (seul les champs nom, prénom et email sont retournés)
attachments	attachments	Les pièces jointes du mail

Exemple de réponse

[
    {
        "id": "oLm7NdD0j7dNGbZQ",
        "created_by": 391,
        "created_at": "2022-02-16T09:32:07.381Z",
        "auto": false,
        "mail": {
            "subject": "Proposition entretien téléphonique",
            "text": "Bonjour Alexandre,\n\nJe reviens vers vous suite à votre candidature pour le poste de Administrateur\nréseaux - Paris - CDI chez Flatchr, est-ce que vous êtes disponible ces\nprochains jours pour un premier entretien téléphonique (15 minutes) ?\n\nDans l'attente de votre retour,\n\nTrès cordialement, ",
            "html": "<p>Bonjour Alexandre,</p><p></p><p>Je reviens vers vous suite à votre candidature pour le poste de Administrateur</p><p>réseaux - Paris - CDI chez Flatchr, est-ce que vous êtes disponible ces</p><p>prochains jours pour un premier entretien téléphonique (15 minutes) ?</p><p></p><p>Dans l'attente de votre retour,</p><p></p><p>Très cordialement, </p>",
            "status": null
        },
        "delivered": false,
        "deliver_at": "2022-02-16T10:34:56.000Z",
        "author": {
            "firstname": "XXXX",
            "lastname": "XXXX"
        },
        "candidate": {
            "firstname": "XXXX",
            "lastname": "XXXX",
            "email": "XXXX@gmail.com"
        },
        "attachments": []
    }
]