Export Submissions (CSV)

Export submissions as CSV. Large exports are processed asynchronously. Requires forms-read.

POST /open/forms/{id}/submissions/export

Export Submissions (CSV)

cURL

curl --request POST \
  --url https://api.opnform.com/open/forms/{id}/submissions/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "columns": {}
}'

200

"<string>"

Export Submissions (CSV)

Export submissions for a form as a CSV file. Large exports are processed asynchronously in the background, while smaller exports are processed immediately.

Authentication & Scope

Requires forms-read ability.

Request

POST /open/forms/{id}/submissions/export HTTP/1.1
Host: api.opnform.com
Content-Type: application/json
Authorization: Bearer <token>

Path Parameters

Parameter	Type	Description
id	number	Numeric ID of the form.

Body Parameters

Field	Type	Required	Description
columns	object	Yes	Keys are field IDs, system columns, or attribution columns such as meta.attribution.utm_source; values indicate whether to include them.

Example payload exporting two fields and the created_at timestamp:

{
    "columns": {
        "field_name": true,
        "field_email": true,
        "meta.attribution.utm_source": true,
        "created_at": true
    }
}

Response

The API automatically determines whether to process the export synchronously or asynchronously based on the form size.

Synchronous Export (Small Forms)

200 OK – Returns a CSV file download immediately. The response’s Content-Type will be text/csv and include the Content-Disposition header.

Asynchronous Export (Large Forms)

200 OK – Returns a job status object for background processing:

{
    "message": "Export started. Large export will be processed in the background.",
    "job_id": "export_abc123def456",
    "is_async": true
}

Use the job_id to check export progress using the Export Status endpoint.

Error Responses

403 Forbidden – The token lacks forms-read or you don’t have access.

Authorizations

Authorization · string · header · required

Personal Access Token

Path Parameters

id · number · required

Body

application/json

columns · object · required

Object mapping field IDs, system columns, or namespaced attribution columns (for example meta.attribution.utm_source) to booleans.

Show child attributes

Response

200

application/json

Synchronous export (CSV file) or asynchronous export (job status)

CSV file download for small forms