File

Download File

GET

Downloads the contents of a file that was previously uploaded to ProjectManager.com.

ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored.

When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API.

If successful, this API returns the file contents as an octet-stream (raw bytes). If an error occurs, you will receive a JSON result with error information.

Path parameters

documentIdstringRequired
The unique identifier of the document to download

Query parameters

typestringOptional

If you specify a type of html, processes the file using text encoding, otherwise binary

Response

This endpoint returns a string
GET
1curl /api/data/files/documentId/download \
2 -H "Authorization: Bearer <token>"
200
Retrieved
1"string"