Skip to main content
GET
List all files
Retrieve a paginated list of files across all cases, with their metadata, analysis status and risk scores.

Permission

You see the files you uploaded and the files recipients uploaded through document requests into cases you created, or every file in your organisation if you have organisation_files:read or your organisation has shared cases enabled. An API key without organisation_files:read receives an empty list, unless your organisation has shared cases enabled. See Permissions and API Keys. Pass scope=own to see only your own files, or scope=org to ask for every file in the organisation. If you cannot see every file, scope=org returns 400 with request.cases.case-file.org-scope-not-permitted.

Key Features

  • Pagination: Use limit and offset query parameters for large result sets.
  • Reverse Chronological: Files are returned newest first.
  • Unified View: See files regardless of which case they belong to.

Best Practices

  1. Batch Processing: Use a limit of 100 for batch background processing.
  2. UI Display: Use a limit of 20-50 for optimal UI performance and loading speed.
  3. Status Filtering: Check the analysis_status to determine which files have completed forensic review.

Authorizations

x-api-key
string
header
required

Query Parameters

limit
integer
default:50

Maximum number of files to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of files to skip for pagination

Required range: 0 <= x <= 9007199254740991
sort_by
enum<string>
default:date_created

Field to sort by

Available options:
date_created,
risk_score
sort_order
enum<string>
default:desc

Sort order: asc (ascending) or desc (descending)

Available options:
asc,
desc
scope
enum<string>

Explicitly request a visibility scope. "own" forces the result to only files the caller created, even if they can view the whole organisation. "org" explicitly requests every file in the organisation — rejected with 400 if the caller cannot view org-wide. Omitted (default): today's behaviour is unchanged — the caller's resolved org-wide visibility decides the result set, with no rejection.

Available options:
own,
org

Response

File list retrieved successfully

files
object[]
required
total
number
required