Vai al contenuto

Ottieni form pubblico GET ​

Leggi un form attivo come lo vede il browser di un visitatore: campi e design, senza nulla di privato. Nessuna autenticazione: è l'endpoint che la pagina del form chiama direttamente.

Endpoint ​

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

Autenticazione ​

Non richiesta

L'endpoint è pubblico. Non restituisce mai il titolo della notifica push, il routing, il contatore delle risposte o qualsiasi altra cosa che vede il proprietario.

Richiesta ​

Parametri di percorso ​

ParametroTipoObbligatorioDescrizione
tidstring✅Identificatore del form, lo stesso che appare in https://frms.click/{tid}

Esempio di richiesta ​

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

Risposta ​

Risposta di successo ​

200 OK

Un form chiuso risponde comunque con 200, con closed: true e un array fields vuoto: così la pagina sa di dover mostrare closed_message al posto dei campi.

CampoTipoDescrizione
tidstringIdentificatore del form
closedbooleantrue quando il form è disattivato, oltre l'orario di chiusura o senza posti di risposta disponibili
fieldsarrayI campi da mostrare: vedi Crea form. Vuoto quando closed è true
settingsobjectTitolo, testi e design: vedi Crea form
allowed_originsarrayHost autorizzati a incorporare il form; vuoto significa ovunque
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": []
}

Campi nascosti

Un campo hidden non viene mostrato. Il suo valore arriva dall'URL della pagina: ?utm_source=newsletter riempie il campo il cui param è utm_source, e viene inviato insieme alla risposta.

Risposte di errore ​

StatoDescrizione
404Form non trovato

Documentazione di Pocket Alert