Uploads

Get Uploads

Get existing uploads from your Papershift account

URL

https://app.papershift.com/public_api/v1/uploads

Method

GET

Parameters

Parameter	Type	Required
api_token	String	required
user_id	Integer	required
user_external_id	String	required if user_id not set
title	String	optional
page	Integer	optional

{
  "api_token": "XXXX",
  "user_id": 1
}

function getUploadsByUser() {
  var api_token = "XXXX";
  var user_id = 1;

  $.ajax({
    url: "https://app.papershift.com/public_api/v1/uploads?api_token=" + api_token + "&user_id=" + user_id,
    type: 'GET',
    dataType: 'json',
    complete: function (data) {
      console.log("Uploads for user:", data.responseText);
    }
  });
}

{
    "uploads": [
        {
            "id": 1,
            "title": "Example File",
            "description": "This is a description.",
            "created_at": "2025-06-24T11:03:29Z",
            "updated_at": "2025-06-24T11:14:22Z",
            "user_id": 1,
            "doc_file_name": "pdf_example.pdf",
            "doc_content_type": "application/pdf",
            "doc_file_size": 1068666,
            "doc_updated_at": "2025-06-24T11:14:22Z",
            "url": "YOUR_URL"
        },
        {
            "id": 2,
            "title": "Example CSV",
            "description": "A very descriptive text.",
            "created_at": "2025-06-24T11:07:53Z",
            "updated_at": "2025-06-24T11:14:39Z",
            "user_id": 1,
            "doc_file_name": "example.csv",
            "doc_content_type": "text/plain",
            "doc_file_size": 1739,
            "doc_updated_at": "2025-06-24T11:13:27Z",
            "url": "YOUR_URL"
        },
        {
            "id": 3,
            "title": "Another File",
            "description": "",
            "created_at": "2025-06-24T11:08:03Z",
            "updated_at": "2025-06-24T11:14:46Z",
            "user_id": 1,
            "doc_file_name": "58480fc5cef1014c0b5e4941.png",
            "doc_content_type": "image/png",
            "doc_file_size": 11580,
            "doc_updated_at": "2025-06-24T11:08:03Z",
            "url": "YOUR_URL"
        }
    ],
    "page_number": 1,
    "total_pages": 1,
    "next_page": null
}

Get Uploads by ID

Get an upload entry by its unique ID

URL

https://app.papershift.com/public_api/v1/uploads/:id

Method

GET

Parameters

Parameter	Type	Required
api_token	String	required
id	Integer	required
user_id	Integer	optional
user_external_id	String	optional (if user_id not set)
page	Integer	optional

https://app.papershift.com/public_api/v1/uploads/1?api_token=XXXX

{
    "upload": {
        "id": 1,
        "title": "Example File",
        "description": "This is a description.",
        "created_at": "2025-06-24T11:03:29Z",
        "updated_at": "2025-06-24T11:14:22Z",
        "user_id": 1,
        "doc_file_name": "pdf_example.pdf",
        "doc_content_type": "application/pdf",
        "doc_file_size": 1068666,
        "doc_updated_at": "2025-06-24T11:14:22Z",
        "url": "YOUR_URL"
    }
}