Use Files API to Access Project Files
Get Files
GET /v2/files
Optional Parameters
- project_id - Project ID
- task_id - Task ID
- subtask_id - Subtask ID
- order - Order of returned records
- limit - Limit number of records returned. Maximum 1000 records
- offset - Start position for fetching records
Sample Response
{
"paging": {
"offset": 0,
"limit": 1000,
"total_records": 2
},
"data": [
{
"hash": "CyhsZCCWuKoB4ZKR",
"file_path": "https://35584cd581deadd2f434-ab84cf451c3f1342ad73a369d28208fd.ssl.cf2.rackcdn.com/e6c0faf81cb34ac0a6d6239a10689247.pdf",
"file_name": "licence_agreement.pdf",
"comment_id": "123",
"project_id": "1",
"task_id": "0",
"subtask_id": "0",
"date_created": "2014-09-19 16:43:41",
"date_modified": "2014-09-19 15:43:41",
"user_id": "1234"
},
{
"hash": "zqkRQYoUkx3vRo1m",
"file_path": "https://35584cd581deadd2f434-ab84cf451c3f1c45ad73a369d28208fd.ssl.cf2.rackcdn.com/52843d59278c3f454682c835adba5643.pdf",
"file_name": "Letterhead.pdf",
"comment_id": "124",
"project_id": "1",
"task_id": "0",
"subtask_id": "0",
"date_created": "2014-09-19 16:43:59",
"date_modified": "2014-09-19 15:43:59",
"user_id": "1234"
}
]
}
"paging": {
"offset": 0,
"limit": 1000,
"total_records": 2
},
"data": [
{
"hash": "CyhsZCCWuKoB4ZKR",
"file_path": "https://35584cd581deadd2f434-ab84cf451c3f1342ad73a369d28208fd.ssl.cf2.rackcdn.com/e6c0faf81cb34ac0a6d6239a10689247.pdf",
"file_name": "licence_agreement.pdf",
"comment_id": "123",
"project_id": "1",
"task_id": "0",
"subtask_id": "0",
"date_created": "2014-09-19 16:43:41",
"date_modified": "2014-09-19 15:43:41",
"user_id": "1234"
},
{
"hash": "zqkRQYoUkx3vRo1m",
"file_path": "https://35584cd581deadd2f434-ab84cf451c3f1c45ad73a369d28208fd.ssl.cf2.rackcdn.com/52843d59278c3f454682c835adba5643.pdf",
"file_name": "Letterhead.pdf",
"comment_id": "124",
"project_id": "1",
"task_id": "0",
"subtask_id": "0",
"date_created": "2014-09-19 16:43:59",
"date_modified": "2014-09-19 15:43:59",
"user_id": "1234"
}
]
}
Example Calls
curl -X GET "https://api.projectbubble.com/v2/files" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"
Response Codes
200 - OK or "No records found"
401 - Permission error. Your user account (API Key) does not have permission to access comments.
401 - Permission error. Your user account (API Key) does not have permission to access comments.
Note: files are stored as comments so to do operations like deleting files then use the Comments resources.
Was this information helpful?
Thank you Your feedback helps us to continually improve our content.
© 2005 - 2023 ProProfs