API Réponses

Récupérer, filtrer, supprimer et exporter les réponses de formulaires.

L'API Réponses vous permet de récupérer, filtrer, supprimer et exporter les soumissions collectées par vos formulaires. Toutes les réponses sont liées à un formulaire spécifique.

Tous les corps de requête et de réponse utilisent des noms de champs en snake_case.

Endpoints

GET/api/v1/forms/:id/responsesGET/api/v1/forms/:id/responses/:responseIdDELETE/api/v1/forms/:id/responses/:responseIdPOST/api/v1/forms/:id/responses/bulk-deleteGET/api/v1/forms/:id/responses/export

Lister les réponses

GET/api/v1/forms/:id/responses

Renvoie une liste paginée des réponses d'un formulaire, triées par date de soumission (les plus récentes en premier).

Paramètres de chemin

idstringrequis

L'identifiant du formulaire

Paramètres de requête

pageinteger

Numéro de page (par défaut : 1)

per_pageinteger

Résultats par page (par défaut : 50)

sincestring

Date ISO 8601. Renvoyer uniquement les réponses soumises à partir de cette date.

untilstring

Date ISO 8601. Renvoyer uniquement les réponses soumises jusqu'à cette date.

completedboolean

Filtrer par statut de complétion. true renvoie uniquement les réponses complétées, false renvoie uniquement les réponses partielles.

Types de valeurs de réponse

short_textstring

Exemple : "Jane Smith"

long_textstring

Exemple : "I really enjoyed the product..."

multiple_choicestring

Exemple : "Option A"

multiple_choice (multi)array of strings

Exemple : ["Option A", "Option C"]

ratingnumber

Exemple : 4

opinion_scalenumber

Exemple : 8

numbernumber

Exemple : 42

emailstring

Exemple : "jane@example.com"

datestring (ISO 8601)

Exemple : "2026-03-15"

yes_noboolean

Exemple : true

file_uploadobject

Exemple : { "url": "...", "name": "doc.pdf" }

dropdownstring

Exemple : "United States"

Réponse

json

{
  "responses": [
    {
      "id": "667a1b2c3d4e5f6a7b8c9d01",
      "form_id": "665a1b2c3d4e5f6a7b8c9d0e",
      "visitor_id": "v_8f2k3j4l5m6n",
      "submitted_at": "2026-02-27T15:42:00.000Z",
      "completed_at": "2026-02-27T15:45:30.000Z",
      "metadata": {
        "user_agent": "Mozilla/5.0",
        "referrer": "https://example.com"
      },
      "answers": [
        {
          "question_id": "66a1b2c3d4e5f6a7b8c9d001",
          "value": "Jane Smith"
        },
        {
          "question_id": "66a1b2c3d4e5f6a7b8c9d002",
          "value": "Social media"
        },
        {
          "question_id": "66a1b2c3d4e5f6a7b8c9d003",
          "value": 5
        }
      ],
      "quiz_results": null
    }
  ],
  "total": 142,
  "page": 1,
  "per_page": 50
}

Exemples de code

bash

curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/responses?page=1&per_page=25&completed=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

Obtenir une réponse

GET/api/v1/forms/:id/responses/:responseId

Récupère une réponse unique par son identifiant.

Paramètres de chemin

idstringrequis

L'identifiant du formulaire

responseIdstringrequis

L'identifiant de la réponse

Résultats de quiz

Pour les formulaires utilisant les modes quiz (knowledge_quiz, lead_qualification, match_quiz), le champ quiz_results contient les données de notation.

Réponse

json

{
  "id": "667a1b2c3d4e5f6a7b8c9d01",
  "form_id": "665a1b2c3d4e5f6a7b8c9d0e",
  "visitor_id": "v_8f2k3j4l5m6n",
  "submitted_at": "2026-02-27T15:42:00.000Z",
  "completed_at": "2026-02-27T15:45:30.000Z",
  "metadata": {
    "user_agent": "Mozilla/5.0",
    "referrer": "https://example.com"
  },
  "answers": [
    {
      "question_id": "66a1b2c3d4e5f6a7b8c9d001",
      "value": "Jane Smith"
    },
    {
      "question_id": "66a1b2c3d4e5f6a7b8c9d002",
      "value": "Social media"
    },
    {
      "question_id": "66a1b2c3d4e5f6a7b8c9d003",
      "value": 5
    }
  ],
  "quiz_results": null
}

Exemple de résultats de quiz

json

{
  "quiz_results": {
    "score": 8,
    "correct_answers": 4,
    "total_scorable_questions": 5,
    "max_score": 10,
    "matched_ending_id": null,
    "form_mode": "knowledge_quiz"
  }
}

Exemples de code

bash

curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/responses/667a1b2c3d4e5f6a7b8c9d01" \
  -H "Authorization: Bearer YOUR_API_KEY"

Supprimer une réponse

DELETE/api/v1/forms/:id/responses/:responseId

Supprime définitivement une réponse unique.

Cette action est irréversible. Les données de la réponse ne peuvent pas être récupérées après suppression.

Paramètres de chemin

idstringrequis

L'identifiant du formulaire

responseIdstringrequis

L'identifiant de la réponse

Réponse

json

{
  "success": true
}

Exemples de code

bash

curl -X DELETE "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/responses/667a1b2c3d4e5f6a7b8c9d01" \
  -H "Authorization: Bearer YOUR_API_KEY"

Suppression groupée de réponses

POST/api/v1/forms/:id/responses/bulk-delete

Supprime plusieurs réponses en une seule requête. Maximum de 100 réponses par requête. Tous les identifiants de réponse spécifiés doivent appartenir au formulaire donné.

Paramètres de chemin

idstringrequis

L'identifiant du formulaire

Corps de la requête

response_idsarray of stringsrequis

Identifiants des réponses à supprimer (max 100)

Exemple de requête

json

{
  "response_ids": [
    "667a1b2c3d4e5f6a7b8c9d01",
    "667a1b2c3d4e5f6a7b8c9d02",
    "667a1b2c3d4e5f6a7b8c9d03"
  ]
}

Réponse

json

{
  "deleted": 3
}

Exemples de code

bash

curl -X POST "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/responses/bulk-delete" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "response_ids": [
      "667a1b2c3d4e5f6a7b8c9d01",
      "667a1b2c3d4e5f6a7b8c9d02"
    ]
  }'

Exporte toutes les réponses d'un formulaire sous forme de fichier CSV. Le CSV inclut des colonnes pour responseId, submittedAt, completedAt, et une colonne par question (utilisant le titre de la question comme en-tête de colonne).

Pour les questions groupées (question_group, multi_question_page, contact_info, address), chaque sous-champ obtient sa propre colonne.

Paramètres de chemin

idstringrequis

L'identifiant du formulaire

Réponse

Renvoie un fichier CSV avec Content-Type: text/csv.

text

responseId,submittedAt,completedAt,What is your name?,How did you hear about us?,How would you rate your overall experience?
667a1b2c3d4e5f6a7b8c9d01,2026-02-27T15:42:00.000Z,2026-02-27T15:45:30.000Z,Jane Smith,Social media,5
667a1b2c3d4e5f6a7b8c9d02,2026-02-26T10:15:00.000Z,2026-02-26T10:18:22.000Z,Bob Johnson,Search engine,4
667a1b2c3d4e5f6a7b8c9d03,2026-02-25T08:30:00.000Z,,Alex Chen,Friend or colleague,

Exemples de code

bash

curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/responses/export" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o responses.csv

Réponses d'erreur

Tous les points d'accès renvoient des réponses d'erreur standard :

Codes de statut

400Bad Request

Paramètres invalides, suppression groupée dépassant 100 éléments

401Unauthorized

Clé API manquante ou invalide

403Forbidden

Permissions d'équipe insuffisantes

404Not Found

Formulaire ou réponse introuvable

500Internal Server Error

Erreur interne du serveur

Exemple d'erreur

json

{
  "error": "Response not found"
}

Dernière mise à jour : 6 avril 2026