Langsung ke konten

Get Public Form GET ​

Baca formulir yang aktif seperti yang dilihat browser pengunjung: kolom dan desainnya, tanpa data pribadi apa pun. Tanpa autentikasi — ini adalah endpoint yang dipanggil langsung oleh halaman formulir.

Endpoint ​

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

Autentikasi ​

Tidak diperlukan

Endpoint ini bersifat publik. Endpoint ini tidak pernah mengembalikan judul push notification, perutean, penghitung respons, atau apa pun yang hanya dilihat pemilik.

Permintaan ​

Path Parameters ​

ParameterTypeRequiredDescription
tidstring✅Pengenal formulir, sama dengan yang muncul di https://frms.click/{tid}

Contoh Permintaan ​

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')

Respons ​

Respons Sukses ​

200 OK

Formulir yang sudah ditutup tetap membalas dengan 200, dengan closed: true dan array fields yang kosong. Dengan cara inilah halaman tahu harus menampilkan closed_message alih-alih kolom input.

FieldTypeDescription
tidstringPengenal formulir
closedbooleantrue saat formulir dimatikan, sudah lewat waktu penutupannya, atau kehabisan slot respons
fieldsarrayKolom yang akan dirender — lihat Create Form. Kosong saat closed
settingsobjectJudul, teks, dan desain — lihat Create Form
allowed_originsarrayHost yang diizinkan menyematkan formulir; kosong berarti boleh dari mana saja
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 fields

Kolom hidden tidak dirender. Nilainya berasal dari URL halaman: ?utm_source=newsletter mengisi kolom yang param-nya utm_source, dan nilai itu ikut terkirim bersama pengiriman.

Respons Error ​

StatusDescription
404Formulir tidak ditemukan

Dokumentasi Pocket Alert