BizKitHub
DocsAPI ReferenceDrive/bff/drive/shares
getDriveAdmin BFF

/bff/drive/shares

Share links and file requests, active first. Filter by file or folder.

DrivegetBffDriveShares

Parameters

2 query

Query parameters

· 2
filestringOptional
Exampleexample_file
folderstringOptional
Exampleexample_folder

Response schema

1 status code documented

200Success
sharesobject[]Required
Each array item:
idstringRequired
urlstringRequired
mode"view" | "upload"Required
status"active" | "expired" | "exhausted" | "revoked"Required
targetobjectRequired
type"file" | "folder"Required
idstringRequired
namestringRequired
pathstringRequired
titlestringOptional
messagestringOptional
hasPasswordbooleanRequired
expiresDatestringOptional
maxDownloadsnumberOptional
downloadCountnumberRequired
uploadCountnumberRequired
lastAccessDatestringOptional
insertedDatestringRequired
createdBystringOptional
contactobjectOptional
idstringRequired
namestringRequired
orderNumberstringOptional

Response example

application/json
{
  "shares": [
    {
      "id": "example_id",
      "url": "example_url",
      "target": {
        "id": "example_id",
        "name": "example_name",
        "path": "example_path"
      },
      "title": "example_title",
      "message": "example_message",
      "hasPassword": false,
      "expiresDate": "example_expiresDate",
      "maxDownloads": 0,
      "downloadCount": 0,
      "uploadCount": 0,
      "lastAccessDate": "example_lastAccessDate",
      "insertedDate": "example_insertedDate",
      "createdBy": "example_createdBy",
      "contact": {
        "id": "example_id",
        "name": "example_name"
      },
      "orderNumber": "example_orderNumber"
    }
  ]
}

Request example

GET /bff/drive/shares

get
curl -X GET "https://api.bizkithub.com/bff/drive/shares?file=example_file&folder=example_folder" \
  -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