フォーム送信API

利用可能なプラン: Professional、Business

フォームAPIを使用する前に、まずフォームのAPIキーを作成し、認証済みリクエストを作成して、フォームのhashidを取得する必要があります。

送信データの取得

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

すべての送信データを取得します。

例：

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

レスポンスの例：

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

結果のフィルタリング

送信データ取得エンドポイントにURLパラメーターを渡すことで、結果をフィルタリングできます。

since

sinceパラメーターを使用して、指定日以降のすべての送信データを取得します。日付は2018-11-03T12:00:00のようにISO形式で指定する必要があります。

例：

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

limit

limitパラメーターを使用して、結果の件数を制限します。

例：

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

offset

offsetパラメーターをページネーションのカーソルとして使用します。前のクエリより前の送信データを表示するためにlimitと組み合わせて使用することが多いです。

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

order

orderパラメーターを使用して並び順を変更します。デフォルトの順序はdesc（降順）です。

例：

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

spam

spamパラメーターを使用して、スパムとしてフラグが立てられたまたはマークされたメッセージを返します。デフォルトではこの値はfalseです。

例：

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

* 注：この機能はまだ完全に展開されていません。すべてのアカウントで利用可能になった際に更新します。