Skip to main content
POST
/
open
/
forms
/
{id}
/
submissions
/
export
Export Submissions (CSV)
curl --request POST \
  --url https://api.opnform.com/open/forms/{id}/submissions/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "columns": {}
}'
This response does not have an example.

​
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

ParameterTypeDescription
idnumberNumeric ID of the form.

​
Body Parameters

FieldTypeRequiredDescription
columnsobjectYesKeys are field IDs (or created_at); values are booleans indicating whether to include the column in the export.
Example payload exporting two fields and the created_at timestamp: 
{
    "columns": {
        "field_name": true,
        "field_email": 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 to booleans to include columns in CSV.

Response

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

  • file
  • object

CSV file download for small forms