GET/organizations/{organizationId}/files/{fileId}

Get file metadata

Returns file metadata and a short-lived download URL when the scan state is ready.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenBearerAuthoptional

Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

fileIdpath · stringrequired

Responses

200application/json

File found.

{
  "id": "fil_01J8FE2X7M5P9Q4V6K1",
  "filename": "northstar-september-export.csv",
  "content_type": "text/csv",
  "size_bytes": 42829120,
  "status": "ready",
  "checksum_sha256": "a7bc2a1e8fa70b02e5c3c28eaf7a315f9767a81700c31ee1d6987b16ef0295c2",
  "download_url": "https://downloads.demo.heyo.example/signed/fil_01J8FE2X7M5P9Q4V6K1",
  "download_expires_at": "2026-09-03T13:00:00Z",
  "metadata": {
    "source": "analytics",
    "contains_pii": false
  },
  "created_at": "2026-09-03T10:00:00Z"
}

idstringoptional

filenamestringoptional

content_typestringoptional

size_bytesintegeroptional

statusstringoptional

checksum_sha256stringoptional

download_urlobjectoptional

download_expires_atobject · date-timeoptional

metadataobjectoptional

created_atstring · date-timeoptional

423

File is still scanning or quarantined.