List files

​

Returns files across your library. Filter by reference to get only the files attached to a specific reference. This list is not paginated: every matching file is returned in one response and cursor is always null.

Query Parameters

  • reference
    Type: string

    Only return files belonging to this reference.

  • fields
    Type: array of stringenum

    Limit the response to specific file fields. id is always included.

    values
    idreferencenamecontent_typesizeprimarymd5created_at
  • expand
    Type: array of "reference"enum
    const:  
    reference

    Expand related objects. Only reference is supported, which replaces the reference ID with the full reference object.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/files
curl https://stage-api.paperpile.com/v1/files \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "b9d1e3f5-7a2c-4b6d-8e0f-1a3c5e7f9b2d",
      "reference": "d4e5f6a7-1b2c-3d4e-5f6a-7b8c9d0e1f2a",
      "name": "wacker2020-sars-cov2-rna.pdf",
      "content_type": "application/pdf",
      "size": 2156432,
      "primary": true,
      "md5": "d41d8cd98f00b204e9800998ecf8427e",
      "created_at": 1705315800
    }
  ],
  "cursor": null,
  "total": 1
}

List of files