Responses-API

Formularantworten abrufen, filtern, löschen und exportieren.

Mit der Responses-API rufst du die von deinen Formularen erfassten Übermittlungen ab, filterst, löschst und exportierst sie. Alle Antworten sind einem bestimmten Formular zugeordnet.

Alle Request- und Antwort-Bodys verwenden Feldnamen in 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

Antworten auflisten

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

Gibt eine paginierte Liste der Antworten eines Formulars zurück, sortiert nach Übermittlungsdatum (neueste zuerst).

Pfad-Parameter

idstringerforderlich

Die Formular-ID

Query-Parameter

pageinteger

Seitennummer (Standard: 1)

per_pageinteger

Ergebnisse pro Seite (Standard: 50)

sincestring

ISO-8601-Datum. Gibt nur Antworten zurück, die an oder nach diesem Datum übermittelt wurden.

untilstring

ISO-8601-Datum. Gibt nur Antworten zurück, die an oder vor diesem Datum übermittelt wurden.

completedboolean

Filtert nach Abschlussstatus. true gibt nur abgeschlossene Antworten zurück, false nur Teilantworten.

Antwortwert-Typen

short_textstring

Beispiel: "Jane Smith"

long_textstring

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

multiple_choicestring

Beispiel: "Option A"

multiple_choice (multi)array of strings

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

ratingnumber

Beispiel: 4

opinion_scalenumber

Beispiel: 8

numbernumber

Beispiel: 42

emailstring

Beispiel: "jane@example.com"

datestring (ISO 8601)

Beispiel: "2026-03-15"

yes_noboolean

Beispiel: true

file_uploadobject

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

dropdownstring

Beispiel: "United States"

Antwort

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
}

Codebeispiele

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"

Antwort abrufen

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

Ruft eine einzelne Antwort per ID ab.

Pfad-Parameter

idstringerforderlich

Die Formular-ID

responseIdstringerforderlich

Die Antwort-ID

Quiz-Ergebnisse

Bei Formularen mit Quiz-Modi (knowledge_quiz, lead_qualification, match_quiz) enthält das Feld quiz_results die Bewertungsdaten.

Antwort

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
}

Beispiel für Quiz-Ergebnisse

json

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

Codebeispiele

bash

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

Antwort löschen

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

Löscht eine einzelne Antwort dauerhaft.

Diese Aktion ist unumkehrbar. Die Antwortdaten können nach dem Löschen nicht wiederhergestellt werden.

Pfad-Parameter

idstringerforderlich

Die Formular-ID

responseIdstringerforderlich

Die Antwort-ID

Antwort

json

{
  "success": true
}

Codebeispiele

bash

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

Antworten massenweise löschen

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

Löscht mehrere Antworten in einem einzigen Request. Maximal 100 Antworten pro Request. Alle angegebenen Antwort-IDs müssen zum angegebenen Formular gehören.

Pfad-Parameter

idstringerforderlich

Die Formular-ID

Request-Body

response_idsarray of stringserforderlich

IDs der zu löschenden Antworten (max. 100)

Request-Beispiel

json

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

Antwort

json

{
  "deleted": 3
}

Codebeispiele

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"
    ]
  }'

Exportiert alle Antworten eines Formulars als CSV-Datei. Die CSV enthält Spalten für responseId, submittedAt, completedAt sowie eine Spalte pro Frage (mit dem Fragetitel als Spaltenüberschrift).

Bei Gruppenfragen (question_group, multi_question_page, contact_info, address) erhält jedes Unterfeld eine eigene Spalte.

Pfad-Parameter

idstringerforderlich

Die Formular-ID

Antwort

Gibt eine CSV-Datei mit Content-Type: text/csv zurück.

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,

Codebeispiele

bash

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

Fehlerantworten

Alle Endpunkte geben Standard-Fehlerantworten zurück:

Statuscodes

400Bad Request

Ungültige Parameter, Massenlöschung überschreitet 100 Einträge

401Unauthorized

Fehlender oder ungültiger API-Schlüssel

403Forbidden

Unzureichende Team-Berechtigungen

404Not Found

Formular oder Antwort nicht gefunden

500Internal Server Error

Interner Serverfehler

Fehlerbeispiel

json

{
  "error": "Response not found"
}

Zuletzt aktualisiert: 20. Juli 2026