API Reference

List files

get
https://api.gathercontent.com/projects//files

List files for a given project

Optional includes:

  • item_instances: Will include a item_instances field that contains an array of item id's that the file is attached via an attachment field.
  • metadata: Will include a metadata field that contains an array of any metadata that the file contains.
  • uploader: Will include avatar,name & initials fields of the user who uploaded the file.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

File URLs

We provide three different URLs for files:

  • url: This URL can be used to render the file contents in a browser.
  • download_url: This URL will force the file to be downloaded using the original filename.
  • optimised_image_url: This is a version in the file optimized for the web.

Please note: For none Image-based files, all URLs will force a download and the content cannot be rendered in the browser. The current supported renderable images are jpeg, png, gif.

Path Params
integer
required

Project id

Query Params
include
array

A comma separated list of extra includes

include
Allowed:
integer
1 to 500

How many results do you want to return (1-500, default 100)

integer
≥ 1

Which page of results do you want to return (default page 1)

enum

Sort results by a given field

Allowed:
enum

Sort results ascending or descending

Allowed:
string

Filter files where original_filename like '%value%'

file_id
array of strings

A comma separated list of file ids

file_id
mime_type
array of strings

Filter files where mime_type is in a comma separated list

mime_type
Responses

Updated 10 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.gathercontent.v2+json

Updated 10 months ago