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.
Path Params
integer
required

Project id

Query Params
include
array

A comma separated list of extra includes

include
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 7 months ago

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