Export Submissions

Export submissions as CSV or JSON. Filter by form, site, or date range.

submissions.export
POST/v1/submissions/export

Request Body

ParameterTypeDescription
formatstringExport format: csv or json (default: csv)
formIdstringFilter by form UUID
siteIdstringFilter by site UUID
presetstringDate preset: today, yesterday, 7d, 30d, 90d, 12m
startDatestringCustom start date (ISO 8601)
endDatestringCustom end date (ISO 8601)
includeMetadatabooleanInclude IP, user agent, referrer (default: true)

Example — Export as CSV

curl
curl -X POST "https://proforms.io/api/v1/submissions/export" \
  -H "Authorization: Bearer pf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "csv",
    "formId": "f_abc123",
    "preset": "30d"
  }' \
  -o submissions.csv

Example — Export as JSON

curl
curl -X POST "https://proforms.io/api/v1/submissions/export" \
  -H "Authorization: Bearer pf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "json",
    "siteId": "s_xyz789",
    "startDate": "2026-01-01T00:00:00Z",
    "endDate": "2026-02-01T00:00:00Z"
  }'
💡
CSV exports include a header row with field labels. The response is streamed as a file download with the appropriate Content-Type and Content-Disposition headers.