Formular-Übermittlungs-API

Verfügbar in: Professional-, Business-Tarif

Bevor du die Formular-APIs nutzen kannst, musst du zunächst die API-Keys deines Formulars erstellen, eine authentifizierte Anfrage erstellen und die hashid deines Formulars abrufen.

Übermittlungen abrufen

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

Rufe alle deine Übermittlungen ab.

Beispiel:

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

Beispielergebnis:

{
  "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
        }
      }
    },
    ...
  ]
}

Ergebnisse filtern

Du kannst die Ergebnisse filtern, indem du URL-Parameter an den Endpoint „Übermittlungen abrufen“ übergibst.

since

Verwende den Parameter since, um alle Übermittlungen ab einem bestimmten Datum abzurufen. Datumsangaben müssen im ISO-Format vorliegen, zum Beispiel 2018-11-03T12:00:00.

Beispiel:

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

limit

Verwende den Parameter limit, um die Anzahl der Ergebnisse zu begrenzen.

Beispiel:

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

offset

Verwende den Parameter offset als Cursor bei der Paginierung. Dieser wird häufig zusammen mit limit eingesetzt, damit du Übermittlungen vor deiner vorherigen Abfrage anzeigen kannst.

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

order

Verwende den Parameter order, um die Reihenfolge zu ändern. Standardmäßig ist die Reihenfolge desc.

Beispiel:

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

spam

Verwende den Parameter spam, um Nachrichten zurückzugeben, die als Spam gekennzeichnet oder markiert wurden. Standardmäßig ist dieser Wert false.

Beispiel:

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

* Hinweis: Funktion, die noch nicht vollständig ausgerollt wurde. Wir aktualisieren dies, sobald die Option für alle Konten verfügbar ist.