Export a form's submissions

GET

/api/v1/forms/{id}/submissions/export

curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/forms/example/submissions/export \
  --header 'Authorization: <Authorization>'

Streams a form’s submissions as CSV or JSON. CSV columns are the sorted union of submitted field names across the exported set. Spam is included when state=all; trash is never exported.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Form ID

Query Parameters

format

string

Csv (default) or json

state

string

All (default), inbox or spam

Responses

200

Streamed export

file

file

Example ^generated

file

400

Bad Request

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

401

Unauthorized

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Forbidden

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Not Found

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}