Beautiful Open-Source Form Builder
---
openapi: post /open/forms/{id}/submissions/export
---
# 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
```http
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:
```json
{
"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:
```json
{
"message": "Export started. Large export will be processed in the background.",
"job_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
"is_async": true
}
```
<Note>
Use the `job_id` to check export progress using the [Export Status
endpoint](/api-reference/submissions/export-status).
</Note>
### Error Responses
`403 Forbidden` – The token lacks `forms-read` or you don't have access.
The `columns` map may include `ip_address`. IP metadata is emitted only when
IP tracking is enabled on the form and available in its workspace plan. Field
columns are matched by their exact saved IDs, including removed fields.
If a form field also uses `ip_address` as its ID, its answer is exported in
its own named column alongside any permitted IP metadata.