Skip to main content
POST
Export form responses as CSV

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
integer
required

ID of the form.

Query Parameters

with_completion_status
string

Export only respondents with this completion status: not_started, in_progress, or completed. Omit it to export every respondent.

from
string<date-time>

Export only respondents last active at or after this time (ISO 8601). Pair with to for a closed range; omit both to export every respondent.

to
string<date-time>

Export only respondents last active at or before this time (ISO 8601).

columns
string[]

Restrict the export to these columns. Detail columns are name, email, phone, completion_status, submitted_at, updated_at, and respondent_type; a question column is question:<form_element_id>. Omit it to export every column.

include_sensitive
boolean

Include answers the form builder marked sensitive. Required for every unmasked export, and honored only for callers holding the forms.view_sensitive permission, root admins, and droplet tokens. Every other export masks them.

Response

object | null

Success

Where to download the finished export.

url

Signed download URL of the CSV file. It expires 12 hours after the export. The file has one row per respondent with the columns respondent_type, respondent_name, respondent_email, respondent_phone, form_completion_status, submitted_at, and updated_at, followed by one column per answered element, headed by the element's label.

meta
object | null

Request metadata.