Aller au contenu

Récupérer tous les formulaires GET ​

Récupérez tous les formulaires de votre compte, du plus récent au plus ancien.

Point de terminaison ​

GET https://api.pocketalert.app/v1/forms

Authentification ​

Obligatoire

Incluez l’un de ces en-têtes dans votre requête :

  • Token: <your-api-key> — Obtenez-la depuis Clés API
  • Authorization: Bearer <jwt-token> — Depuis Connexion

Requête ​

En-têtes ​

En-têteObligatoireDescription
Token✅Votre clé API
Authorization✅Bearer <jwt-token>

Exemple de requête ​

bash
curl -X GET "https://api.pocketalert.app/v1/forms" \
  -H "Token: your-api-key"
javascript
const response = await fetch('https://api.pocketalert.app/v1/forms', {
  headers: { 'Token': 'your-api-key' }
});

const forms = await response.json();
forms.forEach((form) => console.log(form.name, `https://frms.click/${form.tid}`));
python
import requests

response = requests.get(
    'https://api.pocketalert.app/v1/forms',
    headers={'Token': 'your-api-key'}
)

for form in response.json():
    print(form['name'], f"https://frms.click/{form['tid']}")
php
$forms = Http::withHeaders([
    'Token' => 'your-api-key',
])->get('https://api.pocketalert.app/v1/forms')->json();

foreach ($forms as $form) {
    echo $form['name'].' https://frms.click/'.$form['tid'].PHP_EOL;
}

Réponse ​

Réponse de succès ​

200 OK

Un tableau de formulaires. Un compte sans formulaire renvoie [].

ChampTypeDescription
tidstringIdentifiant du formulaire — le lien public est https://frms.click/{tid}
namestringNom interne, affiché dans votre tableau de bord
fieldsarrayLes champs du formulaire — voir Créer un formulaire
settingsobjectTitre, textes et design — voir Créer un formulaire
application_tidstringApplication à laquelle appartiennent les envois (vide si aucune)
device_tidstringTID de l’appareil cible, all, ou vide pour tous les appareils
default_levelint | nullNiveau de priorité appliqué aux envois (-2..2)
push_titlestringModèle de titre de la notification push (vide signifie Form: {name})
allowed_originsarrayHôtes autorisés à intégrer et soumettre le formulaire (vide signifie partout)
max_responsesintPlafond de réponses, 0 pour illimité
closes_atstring | nullDate de fermeture, RFC 3339 en UTC
closedbooleanIndique si le formulaire refuse actuellement les envois
is_activebooleanInterrupteur marche/arrêt du propriétaire
submissions_countintNombre de réponses reçues à ce jour
last_submission_atstringDernière réponse, dans le fuseau horaire de votre compte
created_atstringDate de création, dans le fuseau horaire de votre compte
json
[
  {
    "tid": "vml19aihrga216gt8apc5e3m9",
    "name": "Contact form",
    "fields": [
      { "id": "name", "type": "text", "label": "Name", "placeholder": "Jane Doe", "required": true },
      { "id": "email", "type": "email", "label": "Email", "placeholder": "[email protected]", "required": true }
    ],
    "settings": {
      "title": "Get in touch",
      "top_text": "Leave your details and we will get back to you shortly.",
      "primary_color": "#3f5cad",
      "submit": { "text": "Submit", "color": "", "size": "md" }
    },
    "application_tid": "qm47b9pzxzx7applfd0",
    "device_tid": "",
    "default_level": null,
    "push_title": "New lead: {Name}",
    "allowed_origins": ["example.com"],
    "max_responses": 0,
    "closes_at": null,
    "closed": false,
    "is_active": true,
    "submissions_count": 12,
    "last_submission_at": "23.09.2026 14:05:11",
    "created_at": "20.09.2026 09:12:40"
  }
]

Réponses d’erreur ​

StatutDescription
401Non autorisé — jeton invalide ou manquant
500Échec du chargement des formulaires

Documentation de Pocket Alert