Dokumentation

Deutsch

English

Deutsch

English

Hell/Dunkel

Form.taxi API ​

Unsere API ermöglicht den Abruf Ihrer Formularsendungen per Datenschnittstelle. Eine beliebige Applikation kann in standardisierter Form darauf zugreifen und alle aktuellen Sendungen inkl. Formulareingaben weiter verarbeiten.

Die API liefert die Daten als JSON, in der Struktur wie bei Beispielantwort dargestellt.

INFO

Unsere API ist ab dem Tarif "Standard" verfügbar. Übersicht Preise

Authentifizierung ​

Bei jedem Request an unsere API muss ein Schlüssel, der sogenannte Api-Key, mitgesendet werden. Damit wird sichergestellt, dass nur authorisierte Anfragen möglich sind. Der Api-Key ist für jedes Formular anders und kann nur für den Datenabruf zu diesem Formular verwendet werden.

Sie finden den Api-Key in den Formulareinstellungen, unter dem Punkt Informationen.

img

INFO

Der Api-Key muss mit jedem Request an unsere API als Header übermittelt werden. Achten Sie dabei darauf, dass der Header-Name genau auf "Api-Key" lautet.

Sendungen abrufen ​

Mit dieser API-Abfrage wird die Liste der Formularsendungen inkl. der Eingaben zurückgeliefert.

Abfrageadresse ​

Die Abfrage muss als GET-Request mit dieser Adresse erfolgen:

https://form.taxi/api/v1/form/submissions/{form_code}

An der Stelle von {form_code} verwenden Sie den Code des Formulars. Sie finden diesen ebenfalls in den Formulareinstellungen.

img

Parameter ​

Mit folgenden optionalen GET-Parametern können Sie die Abfrage anpassen und filtern.

since ​

Mit dem since Parameter können Sie die Sendungsliste auf eine bestimmtes Startdatum einschränken. Die Datumsangabe muss dabei im ISO-8601-Format übermittelt werden.

Beispiel:

https://form.taxi/api/v1/form/submissions/{form_code}?since=2025-08-13T13:15:50+02:00

limit ​

Verwenden Sie den limit Parameter um die gelieferten Sendungen auf eine maximale Anzahl zu begrenzen. Standard: 25, Maximum: 50

Beispiel:

https://form.taxi/api/v1/form/submissions/{form_code}?limit=10

page ​

Mit page geben Sie an welche Seite der Sendungsliste geliefert werden soll. Standard: 1

Beispiel:

https://form.taxi/api/v1/form/submissions/{form_code}?page=2

spam ​

Standardmässig werden per API nur Sendungen aus der Inbox geliefert. Wenn Sie zusätzlich die Sendungen aus dem Spam-Ordner erhalten möchten, können Sie dies mit dem spam Parameter erreichen.

Beispiel:

https://form.taxi/api/v1/form/submissions/{form_code}?spam=true

attachments ​

Die Sendungsdaten werden automatisch mit den Dateianhängen geliefert. Wenn Sie keine Dateianhänge erhalten möchten, können Sie dies mit dem attachments Parameter deaktivieren.

Beispiel:

https://form.taxi/api/v1/form/submissions/{form_code}?attachments=false

Beispielantwort ​

json
{
    "success": true,
    "data": {
        "pagination": {
            "countTotal": 54,
            "countPage": 25,
            "currentPage": 1,
            "totalPages": 2
        },
        "form": {
            "code": "cp2j57ye",
            "title": "Mein Kontaktformular",
            "url": "https://domain.com"
        },
        "submissions": [
            {
                "_id": "rIYOyM9pUebOq1kwvoz6M0JcXhhVsuuK",
                "_date": "2024-08-21T11:59:32+02:00",
                "_box": "inbox",
                "fields": {
                    "Email": "email@domain.com",
                    "Nachricht": "Das ist meine Nachricht."
                },
                "attachments": [
                    {
                        "fieldName": "Bildanhang",
                        "fileName": "Foto.jpg",
                        "fileSize": "896641",
                        "url": "https://form.taxi/download/pPzaimJfruButrcB/Foto.jpg",
                    },
                    ...
                ]
            },
            ...
        ]
    }
}