Nifty Developer API

Get Files

GET /api/v1.0/files

Bearer

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 or descending.

Responses

• 200 object

Success Response
- hasMore boolean
  
  True if there are more record else false
  
  Default value is false.
- files array[object] Required
  
  List of Label records
  id string Required
  
  name string Required
  
  size number Required
  
  url string Required
  
  download string Required
  
  thumbnail string Required
  
  uploader string Required
  
  comments number Required
  
  Number of comments
  
  created_at string(date-time) Required
  
  googleId string Required
  
  googleType string Required
  
  processed boolean Required
  
  task string Required
  
  Task
  
  project_id string Required
  
  Project ID
  
  message string Required
  
  Message
  
  labels array[string] Required
  
  List of labels
  
  folder string Required
  
  folder
  
  folder_stack array[string] Required
  
  Folder path stack
  
  document string Required
  
  Document
  
  annotations_task_id string Required
  
  Annotation Task ID
• 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"
    }
  ]
}