List Folder Documents

GET /api/documents/category

Return a list of documents and folders in a folder

Query parameters

  • id string Required

    Category ID

Responses

GET /api/documents/category
curl \
 -X GET http://api.example.com/api/documents/category?id=string \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (default)
{
  "FOLDERS": [
    {
      "pathTree": "string",
      "validTo": "2024-05-04T09:42:00+00:00",
      "relatedID": 42,
      "timeSensitive": true,
      "validFrom": "2024-05-04T09:42:00+00:00",
      "idTree": "string",
      "parentID": 42,
      "webDavAccess": true,
      "id": 42,
      "modified": "2024-05-04T09:42:00+00:00",
      "name": "string",
      "relatedType": "blog"
    }
  ],
  "DOCUMENTS": [
    {
      "filetype": "xlsx",
      "shortDescription": "string",
      "validTo": 42,
      "pathTree": "string",
      "created": "2024-05-04T09:42:00+00:00",
      "validFrom": 42,
      "relatedID": 42,
      "timeSensitive": true,
      "categoryID": 42,
      "createdBy": 42,
      "showThumbnail": true,
      "modifiedBy": 42,
      "idTree": "string",
      "processed": true,
      "preventDownload": true,
      "status": "active",
      "webDavAccess": true,
      "size": 42,
      "modified": 42,
      "id": 42,
      "name": "string",
      "copied": true,
      "description": "file description",
      "relatedType": "string"
    }
  ]
}