List references in a folder

​

Returns references in this folder. Equivalent to GET /references?folder={folder_id} and accepts the same filters, sorting, field selection, and pagination as the references list.

Path Parameters

  • folder_id
    Type: string
    required

    Folder ID

Query Parameters

  • q
    Type: string

    Search query. Supports field prefixes (title:, author:), phrase search ("..."), and negation (not:).

  • type
    Type: array of stringenum

    Only return references of these types.

    values
    • article
    • artwork
    • audio
    • bill
    • book
    • book_chapter
    • broadcast
    • case
  • starred
    Type: boolean

    true = starred only, false = unstarred only, omit = all.

  • folder
    Type: array of string

    Only return references in these folders.

  • label
    Type: array of string

    Only return references with these labels.

  • collection
    Type: array of string

    Only return references in any of these folders or labels.

  • has_pdf
    Type: boolean

    true = has primary PDF, false = no primary PDF

  • has_attachments
    Type: boolean

    true = has any file attached, false = no files

  • has_note
    Type: boolean

    true = has notes or annotations, false = none

  • has_label
    Type: boolean

    true = has any label, false = unlabeled

  • has_folder
    Type: boolean

    true = in any folder, false = unfiled

  • incomplete
    Type: boolean

    true = missing required fields, false = complete metadata

  • trashed_mode
    Type: "exclude" or "only" or "include"enum

    Trash filter mode: exclude = active only (default), only = trashed only, include = active + trashed.

  • sort
    Type: stringenum

    Field to sort by. relevance orders by search match quality and needs q; without one the order is unspecified.

    values
    date_addeddate_publishedtitlefirst_authorjournalrelevance
  • order
    Type: "asc" or "desc"enum

    Sort direction: asc = oldest/A-Z first, desc = newest/Z-A first.

  • fields
    Type: array of stringenum

    Limit the response to specific fields. Only the listed field names are returned for each result.

    values
    • id
    • type
    • created_at
    • citekey
    • files
    • title
    • starred
    • trashed
  • expand
    Type: array of "folders" or "labels" or "files"enum

    Expand related objects. Pass field names to get full objects instead of IDs.

  • cursor
    Type: string

    Opaque cursor from a previous response, passed to fetch the next page.

  • limit
    Type: integer
    min:  
    1
    max:  
    100

    Number of items per page (1-100, default: 50). Values above 100 are rejected.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/folders/{folder_id}/references
curl 'https://stage-api.paperpile.com/v1/folders/{folder_id}/references?trashed_mode=exclude&sort=date_added&order=asc' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "d4e5f6a7-1b2c-3d4e-5f6a-7b8c9d0e1f2a",
      "type": "article",
      "title": "Secondary structure determination of conserved SARS-CoV-2 RNA elements by NMR spectroscopy",
      "author": [
        {
          "kind": "person",
          "family": "Wacker",
          "given": "Anna"
        },
        {
          "kind": "person",
          "family": "Weigand",
          "given": "Julia E."
        },
        {
          "kind": "person",
          "family": "Akabayov",
          "given": "Sridhar R."
        },
        {
          "kind": "person",
          "family": "Altincekic",
          "given": "Nadide"
        },
        {
          "kind": "person",
          "family": "Bains",
          "given": "Jasleen Kaur"
        },
        {
          "kind": "person",
          "family": "Marć",
          "given": "Mirko Hennig"
        },
        {
          "kind": "person",
          "family": "Frolow",
          "given": "Oliver"
        },
        {
          "kind": "person",
          "family": "Hengesbach",
          "given": "Martin"
        }
      ],
      "journal": "Nucleic Acids Res.",
      "volume": "48",
      "issue": "22",
      "pages": "12415-12435",
      "published": "2020",
      "doi": "10.1093/nar/gkaa1013",
      "pmid": "33167030",
      "abstract": "The SARS-CoV-2 genome contains functionally important RNA structural elements that are potential drug targets. Here we report the NMR-derived secondary structures of twelve RNA elements located in the 5′-UTR and the 3′-UTR of the SARS-CoV-2 genome.",
      "starred": true,
      "trashed": false,
      "folders": [
        "91a7c3e5-4b2d-48f6-a810-6d9f5e3c1b7a"
      ],
      "labels": [
        "f2a4c6e8-1b3d-5f7a-9c2e-4d6f8a0b2c4e"
      ],
      "created_at": 1705312200
    }
  ],
  "cursor": null,
  "total": 1
}

List of references