Skip to main content
GET
/
v1
/
files
/
{fileId}
Get file metadata
curl --request GET \
  --url https://api-eu.flexportal.io/v1/files/{fileId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-ID: <tenant-id>'
{
  "fileId": "<string>",
  "tenantId": "<string>",
  "orderId": "<string>",
  "type": "<string>",
  "category": "generated",
  "filename": "<string>",
  "contentType": "<string>",
  "fileSize": 123,
  "storagePath": "<string>",
  "uploadedBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "originalFilename": "<string>",
  "metadata": {}
}

​
Overview

Retrieve metadata for a single file. Use this to get file details before downloading or to verify file properties.

​
Response Fields

FieldDescription
fileIdUnique file identifier
fileNameOriginal file name
fileTypeType: contract, invoice, document, attachment
mimeTypeMIME type
sizeFile size in bytes
orderIdAssociated order ID
customerIdAssociated customer ID
createdAtWhen file was created
updatedAtLast modification

​
Common Use Cases

  • Pre-Download Check: Verify file exists and get metadata
  • File Information: Display file details in UI
  • Validation: Check file type and size before processing

​
Example: Display File Info

async function getFileInfo(fileId) {
  const file = await getFile(fileId);

  return {
    name: file.fileName,
    type: file.fileType,
    size: `${(file.size / 1024).toFixed(1)} KB`,
    created: new Date(file.createdAt).toLocaleDateString()
  };
}

Authorizations

​
Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

​
Tenant-ID
string
required

Your tenant identifier

Path Parameters

​
fileId
string
required

The file ID

Response

File metadata

​
fileId
string
required
​
tenantId
string
required
​
orderId
string
required
​
type
string
required
​
category
enum<string>
required
Available options:
generated,
uploaded
​
filename
string
required
​
contentType
string
required
​
fileSize
number
required
​
storagePath
string
required
​
uploadedBy
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
originalFilename
string
​
metadata
object