Exports

List a form's exports

GET/v1/exports

A form's exports, newest first, up to 20. Each looks like GET /v1/exports/{exportId}. A deleted form's exports stay readable until they expire.

curl "$AYEFORM_API/v1/exports?formId=FORM_ID" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

{
  "items": [
    {
      "id": "18896ze4e004ktexgnwk11v4ch1ejd60",
      "formId": "v7wskeddca2z4gmve1gy0vfpx75gt60p",
      "status": "running",
      "rows": 1,
      "bytes": 184320,
      "filename": "delivery-orders.csv",
      "filtered": false,
      "filters": {
        "status": "complete",
        "state": "started",
        "endingId": "9dxjtjjp7tvdcdkqc803bd7c776krztx",
        "consent": "agreed",
        "from": 1,
        "to": 1,
        "search": "…",
        "sort": "createdAt",
        "order": "desc"
      },
      "error": null,
      "mine": false,
      "createdAt": 1790879400000,
      "finishedAt": 1790879400000
    }
  ]
}

Query parameters

formIdstringrequired
The form.

Response

itemsarray of objectrequired
Newest first, up to 20. mine marks the ones you started.
Show 12 fieldsHide 12 fields
- idstringrequired
  The export's id.
- formIdstringrequired
  The form whose responses it exports.
- statusenumrequired
  running while the file is being prepared, with rows counting the responses written so far. ready once you can call POST /v1/exports/{exportId}/download, and the file is kept for a day. expired once the file was deleted, so export again. failed when it went wrong, and error says why. canceled when someone stopped it.
  One of "running", "ready", "failed", "canceled", "expired"
- rowsnumberrequired
  How many responses were written so far. Once ready, it's all of them.
- bytesnumberrequired
  The file's size so far, in bytes.
- filenamestringrequired
  The CSV file's name.
- filteredbooleanrequired
  Whether any filter was on. A filtered file has "-filtered-" in its name.
- filtersobjectrequired
  The filters and sort it was asked for, as in GET /v1/submissions.
  Show 9 fieldsHide 9 fields
  statusenum
  One of "partial", "complete"
  stateenum
  One of "started", "left", "finished"
  endingIdstring
  consentenum
  One of "agreed", "not_agreed", "not_asked"
  fromnumber
  tonumber
  searchstring
  sortenum
  One of "createdAt", "status", "ending", "contact"
  orderenum
  One of "desc", "asc"
- errorstring or nullrequired
  Why it failed. Null otherwise.
- minebooleanrequired
  Whether you started it. Over the API, that means with this key.
- createdAtnumberrequired
  When it started, in milliseconds since the epoch.
- finishedAtnumber or nullrequired
  When it stopped running, in milliseconds since the epoch. Null while it runs.

Errors answer with a status and the error shape.