ePost eArchive

Get all folders (branded folders, unbranded folders and subfolders) in the Storage

get/epost/v2/archives/directories

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/epost/v2/archives/directories
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Response

Retrieve folders successfully.

directoryIdstring

Id of the directory. Empty for branded directory.

directoryNamestring

Name of the directory

numberOfDocumentsinteger

Number of documents in the directory

parentDirectoryIdsstring[]

The parent folder's IDs of the folder. Empty if the folder is in the root storage.

hasSubDirectoriesboolean

Flag indicating whether the folder has subdirectories.

Example response

[
  {
    "directoryId": "6406a0a6f000d7555cfffb92",
    "directoryName": "Working",
    "numberOfDocuments": 10,
    "parentDirectoryIds": [
      "63f5e84ac1e69b3f45d54097",
      "63f5e9f4c1e69b3f45d555da"
    ],
    "hasSubDirectories": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.