Exports

Get download links

POST/v1/exports/{exportId}/download

Download links for a ready export. They work for 10 minutes and need no API key, so call again for fresh ones. Before the export is ready it answers 409 not_ready. A day after it was ready the file is deleted, and it answers 410 expired, so export again. A file of more than 8000 parts, about 32 GB, answers 413 too_large.

curl -X POST "$AYEFORM_API/v1/exports/$EXPORT_ID/download" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

200 Response

{
  "filename": "delivery-orders.csv",
  "rows": 1,
  "bytes": 184320,
  "url": "https://luigispizza.com",
  "expiresAt": 1790879400000,
  "parts": [
    {
      "url": "https://luigispizza.com",
      "bytes": 184320
    }
  ]
}

Path parameters

exportIdstringrequired
The export's id.

Response

filenamestringrequired
The CSV file's name.
rowsnumberrequired
How many responses the file holds.
bytesnumberrequired
The file's size in bytes.
urlstringrequired
A link to the whole CSV file. It needs no API key.
expiresAtnumberrequired
When the links stop working, 10 minutes from now, in milliseconds since the epoch.
partsarray of objectrequired
The same file in pieces of a few MB, in order. Joined together they make the file. Use them if you want smaller requests.
Show 2 fieldsHide 2 fields
- urlstringrequired
- bytesnumberrequired

Errors answer with a status and the error shape.