API Reference - Files

 

Listing Files

Returns a collection of file records, optionally filtered by the available request parameters.

GET /api/v1/files

 

Available Request Parameters:

Name Type Required Description
id integer no ID of the file.
name string no Name of the file (as stored in Trackops).
filename integer no Raw file name, with extension (as stored in Trackops).
case integer no ID of the case connected to this file.
mime_type string no The mime type associated with this file (e.g. application/pdf).
created_from timestamp no Created on or after the date, as determined by the system.
created_to timestamp no Created on or before the date, as determined by the system.
updated_from timestamp no Updated on or after the date, as determined by the system.
updated_to timestamp no Updated on or before the date, as determined by the system.

Note: All timestamp parameters are queried and returned in UTC.

A Note about File URLs

When retrieving a file list, it will include a secure expiring URL to download each file.  It is important to note that these URLs are only valid for 15 minutes, so if you do not use the link within this time frame, you must re-query the API to get new URLs.  Because of this, you may want to consider reducing the per_page query parameter so you have ample time to handle the requested files without hitting the URL expiration.

Getting a File

Returns a single file record, based on the numeric ID.

GET /api/v1/files/{file_id}

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request