Download File


Downloads files from an attachment field in an app.
Method GET
URL https://{subdomain}
Authentication API Token Authentication , Password Authentication
Content-Type application/json (not needed if specifying the query with a query string)


As long as the correct fileKey is used, no permission is needed.

Request Parameters

The file is downloaded by sending the fileKey of the attachment file. This fileKey though will first need to be obtained using the Get Record API.

Note that this fileKey is different from the fileKey obtained from the response when using the Upload File API.

fileKey String Yes The value that is set on the Attachment field in the response data returned when using the Get Record API.

Sample Request (Query String)


curl Sample

Sample Request (JSON)


Data cannot be set in the body for GET methods when using XMLHttpRequest (XHR).

curl Sample

Sample Response

The MIME media type of the uploaded file will be stated in the Content-Type, and information of the file will be set inside the response body.

Obtaining the fileKey

The fileKey of a file can be found in the response of the Get Record API
Below is a sample response including the fileKey to be used with the Download File API.


Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!