API de soumissions de formulaire

Disponible sur : formules Professional et Business

Avant de pouvoir utiliser les API de formulaire, vous devez d’abord créer les clés API de votre formulaire, effectuer une requête authentifiée, et récupérer le hashid de votre formulaire.

Récupérer les soumissions

GET https://formspree.io/api/0/forms/<hashid>/submissions

Récupère toutes vos soumissions.

Exemple :

curl -u :API_KEY https://formspree.io/api/0/forms/<hashid>/submissions

Exemple de résultat :

{
  "fields": [
    "_date", 
    "email", 
    "message",
    "_status"
  ], 
  "submissions": [
    {
      "_date": "2018-11-03T07:28:29.707632", 
      "email": "myemail@example.com", 
      "message": "asdfasdf",
      "_status": {
        "my@email.com": {
          "delivered": true,
          "processed": true,
          "dispatched": true
        },
        "plugin:discord": {
          "processed": true
        }
      }
    },
    ...
  ]
}

Filtrer les résultats

Vous pouvez filtrer les résultats en passant des paramètres d’URL au point de terminaison de récupération des soumissions.

since

Utilisez le paramètre since pour obtenir toutes les soumissions depuis une date donnée. Les dates doivent être au format ISO, par exemple 2018-11-03T12:00:00.

Exemple :

curl https://formspree.io/api/0/forms/<hashid>/submissions?since=2018-11-03T12:00:00

limit

Utilisez le paramètre limit pour limiter le nombre de résultats.

Exemple :

curl https://formspree.io/api/0/forms/<hashid>/submissions?limit=10

offset

Utilisez le paramètre offset comme curseur de pagination. Il est souvent utilisé conjointement avec limit, afin de consulter les soumissions antérieures à votre requête précédente.

curl https://formspree.io/api/0/forms/<hashid>/submissions?offset=10

order

Utilisez le paramètre order pour modifier l’ordre d’affichage. Par défaut, l’ordre est desc (décroissant).

Exemple :

curl https://formspree.io/api/0/forms/<hashid>/submissions?order=asc

spam

Utilisez le paramètre spam pour retourner les messages signalés ou marqués comme spam. Par défaut, cette valeur est false.

Exemple :

curl https://formspree.io/api/0/forms/<hashid>/submissions?spam=true

* Remarque : cette fonctionnalité n’est pas encore entièrement déployée. Nous mettrons cette page à jour lorsqu’elle sera disponible pour tous les comptes.