BizKitHub
DocsAPI ReferenceDrive/bff/drive/scope
getDriveAdmin BFF

/bff/drive/scope

recent = uploaded in the last 90 days, newest first; all = every file; root = files outside any folder; large = biggest first; search = filename and folder-name match; starred = starred by the viewer; old = not changed for a year; duplicates = identical content (grouped by duplicateKey); label = carries labelId. Files carry their folder path in location.

DrivegetBffDriveScope

Parameters

7 query

Query parameters

· 7
scope"recent" | "all" | "root" | "large" | "search" | "starred" | "old" | "duplicates" | "label"Required
labelIdstring | numberOptional

scope=label.

qstringOptional

Search term (scope=search, min. 2 chars). Case- and diacritics-insensitive.

Length: 0–200
Exampleexample_q
sort"name" | "size" | "date" | "kind"Optional
direction"asc" | "desc"Optional
offsetstring | numberOptional
Range: 0–∞
limitstring | numberOptional
Range: 1–500

Response schema

1 status code documented

200Success
scopestringRequired
folderListobject[]Required
Each array item:
idstringRequired
namestringRequired
pathstringRequired
locationstringOptional
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
offsetnumberRequired
limitnumberRequired
hasMorebooleanRequired

Response example

application/json
{
  "scope": "example_scope",
  "folderList": [
    {
      "id": "example_id",
      "name": "example_name",
      "path": "example_path",
      "location": "example_location",
      "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
}

Request example

GET /bff/drive/scope

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