Skip to content

Get File

GET/web/v1/files/query/{fileBizId} JWT + Turnstile

Retrieves the metadata of a single file by its business ID. This does not return the file content; use the download endpoints for that.

Required Headers

HeaderExample ValueDescription
Content-Typeapplication/jsonRequest content type
Acceptapplication/jsonExpected response type
X-Client-HashClient device fingerprint
Accept-Languageen, zh, zh-Hant, ja, viResponse language (default: en)
AuthorizationBearerJWT access token
X-Workspace-IdTarget workspace ID

Request Parameters

NameTypeRequiredInDescription
fileBizIdstringRequiredpathFile business ID

Success Response

Success 200
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "file_abc123",
    "bucket": "default",
    "objectKey": "uploads/2026/03/21/file_abc123.pdf",
    "originalFilename": "invoice.pdf",
    "fileSize": 102400,
    "contentType": "application/pdf",
    "fileCategory": "DOCUMENT",
    "fileStatus": "ACTIVE",
    "etag": "d41d8cd98f00b204e9800998ecf8427e",
    "remark": "Monthly invoice",
    "createdAt": "2026-03-21T00:00:00Z",
    "createdBy": "acc_user123"
  }
}

Error Responses

Unauthorized 401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}
Not Found 404
{
  "success": false,
  "code": "4040",
  "message": "File not found"
}

Notes

SlaunchX Internal Documentation