Get Files
GET
/api/v1.0/files
This endpoint fetch list of files based on the given query parameters.
Query parameters
-
project_id string Required
Project ID
-
task_id string Required
Task ID
-
doc_id string Required
Document ID
-
user_id string Required
User ID
-
type string
Type
-
limit string
No of records per page
-
offset string
Record Offset
-
folder_id string
Folder ID
-
name string
File Name
-
group string
Group
-
tag string
Tag
-
sort string
Sorting order, default is descending
Values are
ascending
ordescending
.
Responses
-
• 200 object
Success Response
-
• 401
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
-
• 403
The client does not have access rights to the content.
-
• 405
The request method is known by the server but is not supported by the target resource.
GET /api/v1.0/files
curl \
-X GET https://openapi.niftypm.com/api/v1.0/files?project_id=string&task_id=string&doc_id=string&user_id=string \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"hasMore": false,
"files": [
{
"id": "string",
"name": "string",
"size": 42.0,
"url": "string",
"download": "string",
"thumbnail": "string",
"uploader": "string",
"comments": 42.0,
"created_at": "2023-05-04T09:42:00+00:00",
"googleId": "string",
"googleType": "string",
"processed": true,
"task": "string",
"project_id": "string",
"message": "string",
"labels": [
"string"
],
"folder": "string",
"folder_stack": [
"string"
],
"document": "string",
"annotations_task_id": "string"
}
]
}