Skip to content

Form.taxi API

Our API allows you to retrieve your form submissions via a data interface. Any application can access them in a standardized format and further process all current submissions, including form entries.

The API delivers the data as JSON, with the structure shown in Example Response.

INFO

Our API is available starting with the "Standard" plan. Pricing overview

Authentication

Every request to our API requires a key, the so-called API key, to be sent. This ensures that only authorized requests are possible. The API key is different for each form and can only be used to retrieve data for that form.

You can find the API key in the form settings, under the Information section.

img

INFO

The API key must be sent as a Header with every request to our API. Make sure the header name is exactly "Api-Key"

Retrieve submissions

This API query returns the list of form submissions including the entries.

Query address

The query must be made as a GET request with this address:

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

Instead of {form_code}, use your form code. You can also find this in the form settings.

img

Parameter

You can customize and filter the query using the following optional GET parameters.

since

Using the since parameter, you can restrict the submissions list to a specific start date. The date must be transmitted in ISO 8601 format.

Example:

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

limit

Use the limit parameter to limit the number of delivered submissions. Default: 25, Maximum: 50

Example:

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

page

With page you specify which page of the submissions list the delivery should be made to. Default: 1

Example:

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

spam

By default, only submissions from the inbox is delivered via the API. If you also want to receive submissions from the spam folder, you can do so using the spam parameter.

Example:

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

attachments

The submission data is automatically delivered with the file attachments. If you do not want to receive file attachments, you can disable them with the attachments parameter.

Example:

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

Example Response

json
{
    "success": true,
    "data": {
        "pagination": {
            "countTotal": 54,
            "countPage": 25,
            "currentPage": 1,
            "totalPages": 2
        },
        "form": {
            "code": "cp2j57ye",
            "title": "My Contact Form",
            "url": "https://domain.com"
        },
        "submissions": [
            {
                "_id": "rIYOyM9pUebOq1kwvoz6M0JcXhhVsuuK",
                "_date": "2024-08-21T11:59:32+02:00",
                "_box": "inbox",
                "fields": {
                    "Email": "email@domain.com",
                    "Message": "This is my message."
                },
                "attachments": [
                    {
                        "fieldName": "Image attachment",
                        "fileName": "Photo.jpg",
                        "fileSize": "896641",
                        "url": "https://form.taxi/download/pPzaimJfruButrcB/Photo.jpg",
                    },
                    ...
                ]
            },
            ...
        ]
    }
}