Form Submissions

Form submission endpoints allow you to submit forms and manage form submissions.

List Form Submissions

Get a list of form submissions (requires authentication).

GET https://v1.freeqr.io/api/form_submissions

Requires Authentication: Yes

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number (default: 1)
limit	integer	No	Items per page (default: 10, max: 100)
sort	string	No	Sort field (id, created_at; default: -id; prefix with - for descending)
filters[submittable_type]	string	Yes	Submittable type. Currently only page is supported. Use page to list submissions for a page.
filters[submittable_id]	string (ULID)	Yes	ID of the submittable (e.g. page ID when submittable_type is page)
filters[form_provider_type]	string	No	Filter by form provider type
filters[form_provider_id]	string (ULID)	No	Filter by form provider ID
filters[seen]	string	No	Filter by seen status (false for unseen)

Response

{
  "data": [
    {
      "data": {
        "id": "01arz3ndektsv4rrffq69g5fav",
        "data": {
          "name": "John Doe",
          "email": "[email protected]",
          "message": "Hello, world!"
        },
        "created_at": "2024-01-01T00:00:00.000000Z",
        "updated_at": "2024-01-01T00:00:00.000000Z",
        "seen_at": null,
        "metadata": {}
      }
    }
  ],
  "meta": {
    "total": 1
  }
}

Get Form Submission

Get a specific form submission by ID.

GET https://v1.freeqr.io/api/form_submissions/{id}

Requires Authentication: Yes

Path Parameters

Parameter	Type	Required	Description
id	string (ULID)	Yes	Form submission ID

Response

{
  "data": {
    "id": "01arz3ndektsv4rrffq69g5fav",
    "submittable_type": "page",
    "submittable_id": "01arz3ndektsv4rrffq69g5fav",
    "form_provider_type": "component",
    "form_provider_id": "01arz3ndektsv4rrffq69g5fav",
    "data": {
      "name": "John Doe",
      "email": "[email protected]",
      "message": "Hello, world!"
    },
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Update Form Submission

Update an existing form submission.

PATCH https://v1.freeqr.io/api/form_submissions/{id}

Requires Authentication: Yes

Path Parameters

Parameter	Type	Required	Description
id	string (ULID)	Yes	Form submission ID

Request Body

{
  "seen_at": "2024-01-01T12:00:00.000000Z",
  "metadata": {
    "custom_field": "value"
  }
}

Parameters

Parameter	Type	Required	Description
seen_at	string (datetime)	No	Timestamp when submission was seen
metadata	object	No	Additional metadata

Response

{
  "data": {
    "id": "01arz3ndektsv4rrffq69g5fav",
    "data": {
      "name": "John Doe",
      "email": "[email protected]",
      "message": "Hello, world!"
    },
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T12:00:00.000000Z",
    "seen_at": "2024-01-01T12:00:00.000000Z",
    "metadata": {
      "custom_field": "value"
    }
  }
}

Delete Form Submission

Delete a form submission.

DELETE https://v1.freeqr.io/api/form_submissions/{id}

Requires Authentication: Yes

Path Parameters

Parameter	Type	Required	Description
id	string (ULID)	Yes	Form submission ID

Response

Returns the deleted form submission resource (same structure as Get Form Submission).