API de envíos de formulario

Disponible en: planes Professional y Business

Antes de poder utilizar las APIs de formularios, primero necesitas crear las claves de API de tu formulario, crear una solicitud autenticada y obtener el hashid de tu formulario.

Obtener envíos

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

Obtén todos tus envíos.

Ejemplo:

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

Ejemplo de resultado:

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

Filtrado de resultados

Puedes filtrar los resultados pasando parámetros de URL al endpoint Get Submissions.

since

Utiliza el parámetro since para obtener todos los envíos a partir de una fecha. Las fechas deben tener formato ISO, como 2018-11-03T12:00:00.

Ejemplo:

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

limit

Utiliza el parámetro limit para limitar la cantidad de resultados.

Ejemplo:

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

offset

Utiliza el parámetro offset como cursor en la paginación. Se usa con frecuencia junto con limit, de modo que puedas ver envíos anteriores a tu consulta previa.

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

order

Utiliza el parámetro order para cambiar el orden. De forma predeterminada, el orden es desc.

Ejemplo:

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

spam

Utiliza el parámetro spam para devolver los mensajes que han sido marcados o señalados como spam. De forma predeterminada, este valor es false.

Ejemplo:

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

* nota: funcionalidad que aún no se ha implementado por completo. Actualizaremos esto cuando la opción esté disponible para todas las cuentas.