List Files

View as Markdown

List source data files available for parser development.

Returns a representative set of uploaded files for the org, newest first. Filter by instrument_id, comma-separated file extensions (e.g. “csv,txt”), or a substring of the file name. Use the file-content tool to inspect a file’s raw contents.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

instrument_idstringOptionalDefaults to
extensionsstringOptionalDefaults to
querystringOptionalDefaults to
limitintegerOptionalDefaults to 50

Response

OK
file_idstring

The file’s ID, for use with the file-content tool.

original_pathstring or null

Original file name / path.

source_typestring or null

Where the file came from (e.g. instrument sync, manual upload).

source_instrument_idstring or null
ID of the instrument that produced the file, if any.
size_kilobytesinteger or null
File size in kilobytes.
crc32c_hashstring or null
Content hash, useful as an idempotency key for parsed rows.
file_created_atdatetime or null
When the source file was created, if known.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error