v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB
Attachments

Listing expected Submission Attachments

You can retrieve the list of expected Submission attachments at this route, along with a boolean flag indicating whether the server actually has a copy of the expected file or not. If the server has a file, you can then append its filename to the request URL to download only that file (see below).

get/v1/projects/{projectId}/forms/{xmlFormId}/submissions/{instanceId}/attachments

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

instanceIdstring required

The instanceId of the Submission being referenced.

Response

OK

namestring required

The name of the file as specified in the Submission XML.

existsboolean required

Whether the server has the file or not.

Example response

[
  {
    "name": "myfile.png",
    "exists": true
  }
]