본문으로 건너뛰기

공개 폼 조회 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 문서