Responses

Get response file links

POST/v1/submissions/{submissionId}/file-urls

Download links for the files uploaded with a response to its file_upload questions. Each link works for 1 hour. See Files.

curl -X POST "$AYEFORM_API/v1/submissions/$SUBMISSION_ID/file-urls" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

200 Response

{
  "items": [
    {
      "fileId": "bbhe1dcr2m48fxf1assy56ehx428qgry",
      "fieldId": "y7ewwzttjnavxq96ctvtn0mg52c91jey",
      "name": "Luigi's Pizza",
      "size": 184320,
      "type": "image/jpeg",
      "url": "https://luigispizza.com",
      "expiresAt": 1790879400000
    }
  ]
}

Path parameters

submissionIdstringrequired
The response's id.

Body

JSON, with Content-Type: application/json.

fileIdstring
Only this file. Leave it out to get every file. A file the response doesn't have answers 404.

Response

itemsarray of objectrequired
Show 7 fieldsHide 7 fields
- fileIdstringrequired
  The file's id.
- fieldIdstringrequired
  The file_upload question it answers.
- namestringrequired
  The file's name.
- sizenumberrequired
  The file's size in bytes.
- typestringrequired
  The file's MIME type, as uploaded.
- urlstringrequired
  A download link that works for 1 hour and needs no API key. It stops working when it expires or the response is deleted.
- expiresAtnumberrequired
  When url stops working, in milliseconds since the epoch.

Errors answer with a status and the error shape.