API per gli invii del modulo

Disponibile su: piani Professional, Business

Prima di poter usare le API dei moduli, devi prima creare le chiavi API del tuo modulo, creare una richiesta autenticata e recuperare l’hashid del tuo modulo.

Ottenere gli invii

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

Recupera tutti i tuoi invii.

Esempio:

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

Risultato di esempio:

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

Filtrare i risultati

Puoi filtrare i risultati passando parametri URL all’endpoint Get Submissions.

since

Usa il parametro since per ottenere tutti gli invii a partire da una data. Le date devono essere in formato ISO, come 2018-11-03T12:00:00.

Esempio:

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

limit

Usa il parametro limit per limitare il numero di risultati.

Esempio:

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

offset

Usa il parametro offset come cursore nella paginazione. Viene spesso usato insieme a limit, in modo da poter visualizzare gli invii precedenti alla tua query precedente.

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

order

Usa il parametro order per cambiare l’ordine. Per impostazione predefinita l’ordine è desc.

Esempio:

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

spam

Usa il parametro spam per restituire i messaggi che sono stati segnalati o contrassegnati come spam. Per impostazione predefinita questo valore è false.

Esempio:

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

* nota: funzionalità non ancora completamente rilasciata. Aggiorneremo questa pagina quando l’opzione sarà disponibile per tutti gli account.