公開フォームを取得 GET
ライブ中のフォームを、訪問者のブラウザが見るとおりに読み取ります。取得できるのはフィールドとデザインだけで、非公開の情報は含まれません。認証は不要です。フォームページ自体が呼び出すエンドポイントです。
エンドポイント
GET https://api.pocketalert.app/v1/forms/{tid}認証
不要
このエンドポイントは公開されています。プッシュ通知のタイトル、ルーティング、回答数のカウンターなど、フォームの所有者だけが見られる情報は一切返しません。
リクエスト
パスパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
tid | string | ✅ | フォームの識別子です。https://frms.click/{tid} に含まれるものと同じです |
リクエストの例
bash
curl -X GET "https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9"javascript
const form = await fetch('https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9')
.then((response) => response.json());
if (form.closed) {
console.log(form.settings.closed_message);
} else {
console.log(form.settings.title, form.fields.length, 'fields');
}python
import requests
form = requests.get('https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9').json()
print(form['settings']['title'], len(form['fields']), 'fields')レスポンス
成功時のレスポンス
200 OK
締め切られたフォームでも 200 が返ります。closed: true になり、fields は空の配列になります。ページはこの値を見て、入力欄の代わりに closed_message を表示します。
| フィールド | 型 | 説明 |
|---|---|---|
tid | string | フォームの識別子 |
closed | boolean | フォームがオフになっている、締切を過ぎている、または回答枠が残っていない場合に true になります |
fields | array | 表示するフィールドです。詳しくは フォームを作成 を参照してください。closed が true の場合は空になります |
settings | object | タイトル、テキスト、デザインです。詳しくは フォームを作成 を参照してください |
allowed_origins | array | フォームの埋め込みを許可するホストです。空の場合はどこからでも埋め込めます |
json
{
"tid": "vml19aihrga216gt8apc5e3m9",
"closed": false,
"fields": [
{ "id": "name", "type": "text", "label": "Name", "placeholder": "Jane Doe", "required": true },
{ "id": "email", "type": "email", "label": "Email", "placeholder": "[email protected]", "required": true },
{ "id": "src", "type": "hidden", "label": "Source", "param": "utm_source" }
],
"settings": {
"title": "Get in touch",
"top_text": "We reply within one business day.",
"success_message": "Thanks! Your response has been sent.",
"closed_message": "This form is no longer accepting responses.",
"background_color": "#f5f5f4",
"card_color": "#ffffff",
"text_color": "#1c1917",
"primary_color": "#3f5cad",
"font_family": "Inter",
"font_size": 16,
"font_weight": 400,
"border_radius": 10,
"hide_branding": false,
"submit": { "text": "Submit", "color": "", "size": "md" }
},
"allowed_origins": []
}非表示フィールド
hidden のフィールドは表示されません。値はページの URL から取得されます。たとえば ?utm_source=newsletter は、param が utm_source のフィールドに値を入れ、送信時にその値を一緒に送ります。
エラーレスポンス
| ステータス | 説明 |
|---|---|
404 | フォームが見つかりません |