Skip to main content

FolderInfo

FolderInfo contains metadata about a folder

Usage profiles​

UsageFields and validation
In responsesView fields

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
folderIdstringOptionalUnique folder ID.
namestringOptionalName of the folder within its parent folder.
pathstringOptionalFull path (e.g., "/documents/work").
parentPathstringOptionalParent folder path.
createdAtstringOptionalRFC3339 timestamp.
modifiedAtstringOptionalRFC3339 timestamp.
metadataMap from string to stringOptionalCustom metadata.
fileCountinteger (int32)OptionalNumber of files (direct children). Minimum: -2147483648. Maximum: 2147483647.
subfolderCountinteger (int32)OptionalNumber of subfolders. Minimum: -2147483648. Maximum: 2147483647.
totalSizeBytesstring (int64)OptionalTotal size of all files in folder (recursive). Pattern: ^-?\d+$.

Where used​

ReferenceRelationship
Create a new folderPOST /api/v1/storage/create-folder
Get storage statePOST /api/v1/storage/get-state
List files and folders in a directoryPOST /api/v1/storage/list-files
StorageManagerStateNested in model

Download the public reference contract.

Document: DOC-API-MODEL-folder-info.