Get Personal Documents

GET /api/v1.0/docs/personal

This endpoint fetch lsit of all the personal documents based on given query parameters.

Query parameters

  • parent_doc_id string

    Parent Document ID

  • limit string

    No of records per page

  • offset string

    Record Offset

  • folder_id string

    Folder ID

  • author string

    Document Author

  • name string

    Document name

  • tag string

    Document Tag

  • sort string

    Sorting order, default is descending

    Values are ascending or descending.

Responses

  • 200 application/json

    Success Response

    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object
      • id string Required
      • name string Required
      • access_type string Required
      • type string Required
      • subtype string Required
      • external_id string Required
      • content object Required
      • author string Required
      • project_id string Required
      • tasks array[string] Required
      • archived boolean Required
      • members array[object] Required
        Hide members attributes Show members attributes object
        • id string Required
        • permission string Required
        • is_author boolean Required
        • active boolean Required
        • last_seen string(date-time) Required
        • last_edited string(date-time) Required
      • discussion_keys array[string] Required
      • public_token string Required
      • share_token string Required
      • created_at string(date-time) Required
      • comments number Required
      • hasAccess boolean Required
      • labels array[string] Required
      • folder string Required
      • order number Required
      • multipage boolean Required
      • parent_doc_id string Required
    • hasMore boolean Required

      True if there are more record else false

      Default value is false.

  • 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/docs/personal
curl \
 --request GET 'https://openapi.niftypm.com/api/v1.0/docs/personal' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "access_type": "string",
      "type": "string",
      "subtype": "string",
      "external_id": "string",
      "content": {},
      "author": "string",
      "project_id": "string",
      "tasks": [
        "string"
      ],
      "archived": true,
      "members": [
        {
          "id": "string",
          "permission": "string",
          "is_author": true,
          "active": true,
          "last_seen": "2025-05-04T09:42:00Z",
          "last_edited": "2025-05-04T09:42:00Z"
        }
      ],
      "discussion_keys": [
        "string"
      ],
      "public_token": "string",
      "share_token": "string",
      "created_at": "2025-05-04T09:42:00Z",
      "comments": 42.0,
      "hasAccess": true,
      "labels": [
        "string"
      ],
      "folder": "string",
      "order": 42.0,
      "multipage": true,
      "parent_doc_id": "string"
    }
  ],
  "hasMore": false
}