API Docs / Schemas / PortalFolderDto

PortalFolderDto

A folder entry for portal document navigation.
Shared between the main API portal-view and client portal folder browsing.

Properties

Name Type Description
folderIdstring

The external platform folder ID

The external platform folder ID

namestring

Display name of the folder

Display name of the folder

pathstring

Path to pass as portalFolderPath when drilling into this folder.
Format: "/" separated folder names, e.g. "Tax Returns/2026".

Path to pass as portalFolderPath when drilling into this folder.
Format: "/" separated folder names, e.g. "Tax Returns/2026".

JSON Example

{
  "folderId": "string",
  "name": "string",
  "path": "string"
}

Contained in Schemas