跳到正文

获取公开表单 GET ​

以访客浏览器的视角读取在线表单:字段和设计样式,不包含任何私密信息。无需身份验证,这正是表单页面本身调用的端点。

端点 ​

GET https://api.pocketalert.app/v1/forms/{tid}

身份验证 ​

无需验证

该端点是公开的。它绝不会返回推送标题、路由设置、响应计数或其他仅表单所有者可见的内容。

请求 ​

路径参数 ​

参数类型必填说明
tidstring✅表单标识符,与 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 而不是输入框。

字段类型说明
tidstring表单标识符
closedboolean表单被关闭、超过截止时间或响应名额已用完时为 true
fieldsarray需要渲染的字段,参见创建表单。当 closed 为 true 时为空
settingsobject标题、文本和设计样式,参见创建表单
allowed_originsarray允许嵌入该表单的主机;为空表示不限制
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未找到表单

Pocket Alert 文档