Zum Inhalt springen

Öffentliches Formular abrufen GET ​

Lies ein aktives Formular so, wie der Browser eines Besuchers es sieht: Felder und Design, aber nichts Privates. Keine Authentifizierung – das ist der Endpunkt, den die Formularseite selbst aufruft.

Endpunkt ​

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

Authentifizierung ​

Nicht erforderlich

Der Endpunkt ist öffentlich. Er liefert nie den Push-Titel, das Routing, den Antwortzähler oder andere Angaben, die nur der Besitzer sieht.

Anfrage ​

Pfadparameter ​

ParameterTypPflichtBeschreibung
tidstring✅Formular-Kennung, dieselbe, die in https://frms.click/{tid} vorkommt

Beispielanfrage ​

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

Antwort ​

Erfolgreiche Antwort ​

200 OK

Ein geschlossenes Formular antwortet trotzdem mit 200, mit closed: true und einem leeren fields-Array. So weiß die Seite, dass sie closed_message statt Eingabefelder anzeigen muss.

FeldTypBeschreibung
tidstringFormular-Kennung
closedbooleantrue, wenn das Formular deaktiviert ist, nach seinem Schlusszeitpunkt liegt oder keine Antwortplätze mehr frei sind
fieldsarrayDie anzuzeigenden Felder – siehe Formular erstellen. Leer, wenn closed
settingsobjectTitel, Texte und Design – siehe Formular erstellen
allowed_originsarrayHosts, die das Formular einbetten dürfen; leer bedeutet überall
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": []
}

Versteckte Felder

Ein hidden-Feld wird nicht angezeigt. Sein Wert kommt aus der Seiten-URL: ?utm_source=newsletter füllt das Feld, dessen param utm_source ist, und wird mit der Übermittlung mitgeschickt.

Fehlerantworten ​

StatusBeschreibung
404Formular nicht gefunden

Pocket Alert Dokumentation