{"_id":"556523f5b60f251900703442","__v":5,"editedParams":true,"editedParams2":true,"user":"555a5da8bcb32e19006f816f","category":{"_id":"55651e0165a1130d00400c32","project":"5548466bd2c8410d006c2143","__v":6,"pages":["55651e6103b6710d00916957","55651ead65a1130d00400c33","55651fb6b893840d00444746","556523f5b60f251900703442","556524f3eb1615230053fd4d","55652555eb1615230053fd4f"],"version":"5548466bd2c8410d006c2146","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-27T01:29:37.594Z","from_sync":false,"order":5,"slug":"files","title":"Files"},"project":"5548466bd2c8410d006c2143","version":{"_id":"5548466bd2c8410d006c2146","project":"5548466bd2c8410d006c2143","__v":8,"createdAt":"2015-05-05T04:26:19.796Z","releaseDate":"2015-05-05T04:26:19.796Z","categories":["5548466cd2c8410d006c2147","554a69ba0b54d30d007fe128","554a7f3338e3620d0082192e","5565162e03b6710d00916942","55651a0c65a1130d00400c2b","55651d4565a1130d00400c2f","55651e0165a1130d00400c32","5565217903b6710d0091695f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-27T01:55:01.840Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"javascript","code":"$.ajax({\n    type: \"GET\", \n    url: \"/api/v1/folders/123/files.json\", \n    contentType: 'application/json', \n    dataType: \"json\", \n    success: worked, \n    headers: { apiKey: apiKey }\n});"},{"code":"<?\n$context = stream_context_create(array(\n  'http'=>array(\n    'method'=>\"GET\",\n    'header'=>\"apiKey: [yourApiKey]\")\n));\n$data = file_get_contents('https://api.projectmanager.com/api/v1/folder/412258/files.json', false, $context);\nprint_r(json_decode($data));\n?>","language":"php"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"status\": \"Okay\",\n    \"files\": [\n        {\n            \"url\": \"https://secure.projectmanager.com/Share/Public/UserFile.aspx?hid=60F80&bid=c75bd554-5263-4de7-9905-656bacb24f88\",\n            \"id\": 397184,\n            \"name\": \"12%20-%201.jpg\"\n        },\n        {\n            \"url\": \"https://secure.projectmanager.com/Share/Public/UserFile.aspx?hid=64A62&bid=c75bd554-5263-4de7-9905-656bacb24f88\",\n            \"id\": 412258,\n            \"name\": \"dh1.jpg\"\n        }]\n}","name":""}]},"auth":"required","params":[{"_id":"55721a4e6d8908230061f4b2","ref":"","in":"path","required":true,"desc":"The unique identifier of the folder from which to retrieve files from.","default":"","type":"int","name":"folderId"}],"url":"/folders/{folderId}/files.json"},"isReference":false,"order":1,"body":"A File instance is represented by the following properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Id\",\n    \"0-1\": \"The unique identifier of the File instance.\",\n    \"1-0\": \"Url\",\n    \"1-1\": \"The download url of the file.\",\n    \"2-0\": \"Name\",\n    \"2-1\": \"The name of the file.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","excerpt":"A File instance represents a file added or attached in ProjectManager.com. This may be a file attached to a Project or shared documents etc.\n\nUse this API to retrieve the files within a given folder.","slug":"retrieve-files-from-folder","type":"endpoint","title":"Files by Folder"}

getFiles by Folder

A File instance represents a file added or attached in ProjectManager.com. This may be a file attached to a Project or shared documents etc. Use this API to retrieve the files within a given folder.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

folderId:
required
integer
The unique identifier of the folder from which to retrieve files from.

Examples


Result Format


Documentation

A File instance is represented by the following properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "Id", "0-1": "The unique identifier of the File instance.", "1-0": "Url", "1-1": "The download url of the file.", "2-0": "Name", "2-1": "The name of the file." }, "cols": 2, "rows": 3 } [/block]