Skip to main content
POST
/
form-element-submissions
/
export
Export form element submissions
curl --request POST \
  --url https://app.azalt.co/api/v1/form-element-submissions/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formIds": [
    "<string>"
  ],
  "siteIds": [
    "<string>"
  ],
  "years": [
    123
  ],
  "includeParentSiteName": false,
  "includeEmptyRows": true,
  "includeElementName": false,
  "includeFormName": false,
  "includeUnits": false,
  "includeMetadata": false,
  "includeElementId": false,
  "format": "csv"
}
'
{
  "content": "<string>",
  "filename": "<string>",
  "format": "csv",
  "mimeType": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
formIds
string[]
required
Minimum array length: 1
siteIds
string[]
required
years
number[]
required
includeParentSiteName
boolean
default:false
includeEmptyRows
boolean
default:true
includeElementName
boolean
default:false
includeFormName
boolean
default:false
includeUnits
boolean
default:false
includeMetadata
boolean
default:false
includeElementId
boolean
default:false
format
enum<string>
default:csv
Available options:
csv,
xlsx

Response

Successful response

content
string
required
filename
string
required
format
enum<string>
required
Available options:
csv,
xlsx
mimeType
string
required