Get Folder Conntents

GET /api/v2.0/folders/content

This endpoint fetch folder contents based on the given query parameters.

Query parameters

  • project_id string Required

    Project Id

  • folder_id string Required

    Folder Id

  • limit number Required

    No of records per page

  • offset number Required

    Record Offset

Responses

  • 200 application/json

    Success Response

    Hide response attributes Show response attributes object
    • hasMore boolean

      True if there are more record else false

      Default value is false.

    • files array[object] Required

      List of Label records

      Hide files attributes Show files 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/v2.0/folders/content
curl \
 --request GET 'https://openapi.niftypm.com/api/v2.0/folders/content?project_id=string&folder_id=string&limit=25&offset=0' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "hasMore": false,
  "files": [
    {
      "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"
    }
  ]
}