BizKitHub
DocsAPI ReferenceDrive/bff/drive/list
getDriveAdmin BFF

/bff/drive/list

Subfolders (not paged) and one page of files of a single folder. Trashed items are excluded. Folder item counts are direct children only; recursive size is served by /folder-stats.

DrivegetBffDriveList

Parameters

7 query

Query parameters

· 7
pathstringOptional

Folder path, e.g. "Contracts/2026". Empty = root.

Example
sort"name" | "size" | "date" | "kind"Optional
direction"asc" | "desc"Optional
offsetstring | numberOptional
Range: 0–∞
limitstring | numberOptional
Range: 1–500
foldersOnlyboolean | stringOptional

Skip files (folder pickers).

missingAsEmptyboolean | stringOptional

A missing folder lists as empty (notFound: true) instead of an error.

Response schema

1 status code documented

200Success
pathstringRequired
folderobject | nullRequired
One of 2:
Variant 1
idstringRequired

Folder external id.

namestringRequired
pathstringRequired

Full path, e.g. "Contracts/2026".

Variant 2
null
folderListobject[]Required
Each array item:
idstringRequired
namestringRequired
itemsCountnumberRequired
insertedDatestringRequired
updatedDatestringOptional
colorstringOptional
starredbooleanOptional
labelIdsnumber[]Optional
fileListobject[]Required
Each array item:
idstringRequired

Blob token.

filenamestringRequired
sizenumberRequired
contentTypestringRequired
extensionstringOptional
tagstringOptional
insertedDatestringRequired
updatedDatestringOptional
isPrivatebooleanRequired
uploadedBystringOptional
locationstringOptional

Folder path ('' = root); cross-folder views only.

starredbooleanOptional

Starred by the viewer.

labelIdsnumber[]Optional
versionCountnumberOptional

Older versions kept in the history.

duplicateKeystringOptional

Duplicates view: equal key = identical content.

fileCountnumberRequired

Files directly in this folder (all pages).

offsetnumberRequired
limitnumberRequired
hasMorebooleanRequired
notFoundbooleanOptional

Response example

application/json
{
  "path": "example_path",
  "folderList": [
    {
      "id": "example_id",
      "name": "example_name",
      "itemsCount": 0,
      "insertedDate": "example_insertedDate",
      "updatedDate": "example_updatedDate",
      "color": "example_color",
      "starred": false,
      "labelIds": [
        0
      ]
    }
  ],
  "fileList": [
    {
      "id": "example_id",
      "filename": "example_filename",
      "size": 0,
      "contentType": "example_contentType",
      "extension": "example_extension",
      "tag": "example_tag",
      "insertedDate": "example_insertedDate",
      "updatedDate": "example_updatedDate",
      "isPrivate": false,
      "uploadedBy": "example_uploadedBy",
      "location": "example_location",
      "starred": false,
      "labelIds": [
        0
      ],
      "versionCount": 0,
      "duplicateKey": "example_duplicateKey"
    }
  ],
  "fileCount": 0,
  "offset": 0,
  "limit": 0,
  "hasMore": false,
  "notFound": false
}

Request example

GET /bff/drive/list

get
curl -X GET "https://api.bizkithub.com/bff/drive/list?path=" \
  -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