List form submissions

GET

/form-submissions

const url = 'https://api.quantcdn.io/v1/form-submissions?form_fields=*&page=1&page_size=10&sort_form_field=last_name&sort_direction=asc';
const options = {
  method: 'GET',
  headers: {
    'Quant-Customer': 'example',
    'Quant-Project': 'example',
    'Quant-Url': '/contact-us',
    'Quant-Token': '<Quant-Token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.quantcdn.io/v1/form-submissions?form_fields=*&page=1&page_size=10&sort_form_field=last_name&sort_direction=asc' \
  --header 'Quant-Customer: example' \
  --header 'Quant-Project: example' \
  --header 'Quant-Token: <Quant-Token>' \
  --header 'Quant-Url: /contact-us'

Returns the submissions captured for a form, newest last. The form is identified by the Quant-Url header — the path of the page it is attached to.

Pass form_fields=* to return every submitted field on every result, which is what you want when exporting. Without it the response contains only submission identifiers and dates.

Results are paginated. Read total_forms from the first response and request further pages until you have them all. There is no date filter — date_submitted is a Unix timestamp, so filter on it client-side.

Authorizations

quant_token

Parameters

Header Parameters

Quant-Customer

required

string

The customer account name

Quant-Project

required

string

The project machine name

Quant-Url

required

string

The path of the page the form is attached to

Example

/contact-us

Query Parameters

form_fields

string

Which submitted fields to include in each result. Use * for every field, or a comma-separated list such as email,organisation. Omit this and each result contains only form_uuid, date_submitted and file_count — no submitted data.

Example

page

integer

default: 1

Page of results to return. Defaults to 1.

page_size

integer

default: 10 <= 500

Results per page. Defaults to 10, and values above 500 are clamped to 500.

form_uuid

string format: uuid

Return one specific submission with its full data. Pagination fields are omitted from the response when this is set.

check_uuid

boolean

Used with form_uuid. Confirms the submission exists without returning its submitted data.

form_search

string

Return only submissions containing this text in any submitted field. The search is case-insensitive and unindexed, so it is slow over large forms.

has_files

boolean

Return only submissions that have (true) or do not have (false) file attachments.

sort_form_field

string

Sort by a submitted field instead of the submission date.

Example

last_name

sort_direction

string

default: asc

Allowed values: asc desc

Sort direction. Defaults to asc.

Responses

200

Okay

application/json

object

forms

The submissions on this page

Array<object>

object

form_uuid

Unique identifier for the submission

string format: uuid

date_submitted

Submission time as a Unix timestamp (seconds, UTC)

integer

file_count

Number of files attached to the submission

integer

form_data

The submitted fields, keyed by field name. Only present when form_fields or form_uuid is supplied. Attachments appear here as a files array.

object

key

additional properties

any

ip_location

Submitting IP address and country code

string

is_spam

Whether spam protection flagged the submission

boolean

spam_score

Score assigned by spam protection

integer

total_forms

Total submissions for this form

integer

total_pages

Total pages at the requested page_size

integer

page

The page returned

integer

page_size

Results per page for this response

integer

Example

{
  "forms": [
    {
      "date_submitted": 1742528890,
      "ip_location": "203.0.113.10 (AU)"
    }
  ]
}

400

The submission data could not be retrieved. Most often the Quant-Customer or Quant-Project value is wrong, or no form exists at the Quant-Url path.

403

The Quant-Token did not match the supplied customer/project