Aller au contenu

Obtenir un formulaire public GET ​

Consultez un formulaire en direct comme le ferait le navigateur d'un visiteur : ses champs et son design, sans aucune donnée privée. Aucune authentification : c'est le point de terminaison appelé par la page du formulaire elle-même.

Point de terminaison ​

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

Authentification ​

Non requise

Le point de terminaison est public. Il ne renvoie jamais le titre de notification push, le routage, le compteur de réponses ni aucune autre information que voit le propriétaire.

Requête ​

Paramètres de chemin ​

ParamètreTypeRequisDescription
tidstring✅Identifiant du formulaire, identique à celui présent dans https://frms.click/{tid}

Exemple de requête ​

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

Réponse ​

Réponse de succès ​

200 OK

Un formulaire fermé répond toujours avec 200, avec closed: true et un tableau fields vide : c'est ainsi que la page sait qu'elle doit afficher closed_message à la place des champs.

ChampTypeDescription
tidstringIdentifiant du formulaire
closedbooleantrue lorsque le formulaire est désactivé, passé sa date de fermeture, ou à court de places de réponse
fieldsarrayLes champs à afficher — voir Créer un formulaire. Vide lorsque closed
settingsobjectTitre, textes et design — voir Créer un formulaire
allowed_originsarrayHôtes autorisés à intégrer le formulaire ; vide signifie n'importe lequel
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": []
}

Champs cachés

Un champ hidden n'est pas affiché. Sa valeur provient de l'URL de la page : ?utm_source=newsletter remplit le champ dont le param est utm_source, et cette valeur est transmise avec l'envoi.

Réponses d'erreur ​

StatutDescription
404Formulaire introuvable

Documentation de Pocket Alert