BizKitHub
DocsAPI ReferenceDrive/bff/drive/list
getDriveAdmin BFF

/bff/drive/list

Returns a list of files and subfolders in the specified directory path, together with recursive directory statistics (total file count, size). Use this endpoint to browse the file storage structure and to show download preview.

DrivegetBffDriveList

Parameters

1 query

Query parameters

· 1
pathstringOptional

Directory path to list. Defaults to root "/".

Example/

Response schema

1 status code documented

200SuccessDirectory listing with folders, files, and recursive statistics.
pathstringRequired

Current directory path.

folderListobject[]Required

List of subfolders in the current directory.

Each array item:
namestringRequired

Folder name.

itemsCountnumberRequired

Number of items in the folder.

fileListobject[]Required

List of files in the current directory.

Each array item:
idstringRequired

Unique file token.

filenamestringRequired

File name.

sizenumberRequired

File size in bytes.

insertedDatestringRequired

Date when the file was uploaded (ISO format).

totalFileCountnumberRequired

Total number of files in directory (recursive).

totalSizenumberRequired

Total size of all files in bytes (recursive).

totalSizeFormattedstringRequired

Human-readable total size (e.g., "1.5 MB").

canDownloadbooleanRequired

Whether the directory can be downloaded as ZIP (false if empty or too many files).

Response example

application/json
{
  "path": "example_path",
  "folderList": [
    {
      "name": "example_name",
      "itemsCount": 0
    }
  ],
  "fileList": [
    {
      "id": "example_id",
      "filename": "example_filename",
      "size": 0,
      "insertedDate": "example_insertedDate"
    }
  ],
  "totalFileCount": 0,
  "totalSize": 0,
  "totalSizeFormatted": "example_totalSizeFormatted",
  "canDownload": false
}

Request example

GET /bff/drive/list

get
curl -X GET "https://api.bizkithub.com/bff/drive/list?path=%2F" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key