List Folder Documents

GET /api/documents/category

Api key

Return a list of documents and folders in a folder

Query parameters

id string Required

Category ID

Responses

default application/json

Category Response
Hide response attributes Show response attributes object
- FOLDERS array[object]
  
  Hide FOLDERS attributes Show FOLDERS attributes object
  
  pathTree string
  
  validTo string(date-time)
  
  relatedID integer
  
  timeSensitive boolean
  
  validFrom string(date-time)
  
  idTree string
  
  parentID integer
  
  webDavAccess boolean
  
  id integer
  
  modified string(date-time)
  
  name string
  
  relatedType string
- DOCUMENTS array[object]
  
  Hide DOCUMENTS attributes Show DOCUMENTS attributes object
  
  filetype string
  
  shortDescription string
  
  validTo integer(date-time)
  
  pathTree string
  
  created string(date-time)
  
  validFrom integer(date-time)
  
  relatedID integer
  
  timeSensitive boolean
  
  categoryID integer
  
  createdBy integer
  
  showThumbnail boolean
  
  modifiedBy integer
  
  idTree string
  
  processed boolean
  
  preventDownload boolean
  
  status string
  
  webDavAccess boolean
  
  size integer
  
  modified integer(date-time)
  
  id integer
  
  name string
  
  copied boolean
  
  description string
  
  relatedType string

GET /api/documents/category

curl \
 --request GET 'http://api.example.com/api/documents/category?id=string' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (default)

{
  "FOLDERS": [
    {
      "pathTree": "string",
      "validTo": "2025-05-04T09:42:00Z",
      "relatedID": 42,
      "timeSensitive": true,
      "validFrom": "2025-05-04T09:42:00Z",
      "idTree": "string",
      "parentID": 42,
      "webDavAccess": true,
      "id": 42,
      "modified": "2025-05-04T09:42:00Z",
      "name": "string",
      "relatedType": "blog"
    }
  ],
  "DOCUMENTS": [
    {
      "filetype": "xlsx",
      "shortDescription": "string",
      "validTo": 42,
      "pathTree": "string",
      "created": "2025-05-04T09:42:00Z",
      "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"
    }
  ]
}