コンテンツへスキップ

すべてのフォームを取得 GET ​

アカウント内のすべてのフォームを、新しいものから順に取得します。

エンドポイント ​

GET https://api.pocketalert.app/v1/forms

認証 ​

必須

リクエストには、次のヘッダーのいずれかを含めてください。

  • Token: <your-api-key> — API キーから取得できます
  • Authorization: Bearer <jwt-token> — ログインから取得します

リクエスト ​

ヘッダー ​

ヘッダー必須説明
Token✅API キー
Authorization✅Bearer <jwt-token>

リクエストの例 ​

bash
curl -X GET "https://api.pocketalert.app/v1/forms" \
  -H "Token: your-api-key"
javascript
const response = await fetch('https://api.pocketalert.app/v1/forms', {
  headers: { 'Token': 'your-api-key' }
});

const forms = await response.json();
forms.forEach((form) => console.log(form.name, `https://frms.click/${form.tid}`));
python
import requests

response = requests.get(
    'https://api.pocketalert.app/v1/forms',
    headers={'Token': 'your-api-key'}
)

for form in response.json():
    print(form['name'], f"https://frms.click/{form['tid']}")
php
$forms = Http::withHeaders([
    'Token' => 'your-api-key',
])->get('https://api.pocketalert.app/v1/forms')->json();

foreach ($forms as $form) {
    echo $form['name'].' https://frms.click/'.$form['tid'].PHP_EOL;
}

レスポンス ​

成功時のレスポンス ​

200 OK

フォームの配列を返します。フォームがないアカウントの場合は [] を返します。

フィールド型説明
tidstringフォームの識別子です。公開リンクは https://frms.click/{tid} になります
namestring内部用の名前で、ダッシュボードに表示されます
fieldsarrayフォームの項目です。詳しくは フォームを作成 を参照してください
settingsobjectタイトル、テキスト、デザインの設定です。詳しくは フォームを作成 を参照してください
application_tidstring送信内容が属するアプリケーションです(未設定の場合は空)
device_tidstring通知先デバイスの TID、all、または全デバイス向けの場合は空
default_levelint | null送信内容に適用される優先度レベルです(-2〜2)
push_titlestringプッシュ通知のタイトルのテンプレートです(空の場合は Form: {name})
allowed_originsarrayフォームの埋め込みと送信を許可するホストです(空の場合は制限なし)
max_responsesint回答数の上限です。無制限の場合は 0
closes_atstring | null締め切り日時です。UTC の RFC 3339 形式になります
closedboolean現在フォームが送信を受け付けていないかどうかです
is_activeboolean所有者がオンとオフを切り替えるスイッチです
submissions_countintこれまでに受け取った回答数です
last_submission_atstring最後の回答日時です。アカウントのタイムゾーンで表示されます
created_atstring作成日時です。アカウントのタイムゾーンで表示されます
json
[
  {
    "tid": "vml19aihrga216gt8apc5e3m9",
    "name": "Contact form",
    "fields": [
      { "id": "name", "type": "text", "label": "Name", "placeholder": "Jane Doe", "required": true },
      { "id": "email", "type": "email", "label": "Email", "placeholder": "[email protected]", "required": true }
    ],
    "settings": {
      "title": "Get in touch",
      "top_text": "Leave your details and we will get back to you shortly.",
      "primary_color": "#3f5cad",
      "submit": { "text": "Submit", "color": "", "size": "md" }
    },
    "application_tid": "qm47b9pzxzx7applfd0",
    "device_tid": "",
    "default_level": null,
    "push_title": "New lead: {Name}",
    "allowed_origins": ["example.com"],
    "max_responses": 0,
    "closes_at": null,
    "closed": false,
    "is_active": true,
    "submissions_count": 12,
    "last_submission_at": "23.09.2026 14:05:11",
    "created_at": "20.09.2026 09:12:40"
  }
]

エラーレスポンス ​

ステータス説明
401認証されていません。トークンが無効または未指定です
500フォームの読み込みに失敗しました

Pocket Alert ドキュメント