Get File

GET /api/v1.0/files/{file_id}

This endpoint fetch the details of the file based on unique file identified

Path parameters

  • file_id string Required

    File ID

Responses

  • 200 application/json

    Success Response

    Hide response attributes Show response attributes object
    • 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/{file_id}
curl \
 --request GET 'https://openapi.niftypm.com/api/v1.0/files/{file_id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "id": "string",
  "name": "string",
  "size": 42.0,
  "url": "string",
  "download": "string",
  "thumbnail": "string",
  "uploader": "string",
  "comments": 42.0,
  "created_at": "2025-05-04T09:42:00Z",
  "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"
}