Paperful Icon

Paperfuldocs

Papers

List Papers

GET
/papers

Returns a paginated list of papers in the current workspace.

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

next?string
prev?string
collectionId?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
fileName?string
archived?string
view?string

Value in

  • "archived"
  • "bin"

Response Body

application/json

curl -X GET "https://example.com/papers"
{  "total": 0,  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "fileName": "string",      "title": "string",      "subject": "string",      "size": 0,      "ratio": 0,      "pages": 0,      "status": "pending",      "version": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "fileName": "string",        "title": "string",        "subject": "string",        "size": 0,        "ratio": 0,        "pages": 0,        "status": "deleted",        "extension": "string"      }    }  ],  "cursor": {    "next": "string",    "prev": "string"  }}