Paperful Icon

Paperfuldocs

Papers

List papers

List and filter the papers in your workspace.

List the papers in your workspace, optionally filtered by name or file type.

List papers

const { items, total } = await paperful.papers.list();

for (const paper of items) {
  console.log(paper.id, paper.fileName);
}

Filter papers

const { items } = await paperful.papers.list({
  fileName: "report",
  extension: ["pdf", "docx"],
});

Paginate

Results are paginated. Pass the returned cursor to get the next page.

let page = await paperful.papers.list();

while (page.cursor?.next) {
  page = await paperful.papers.list({ next: page.cursor.next });
}

Options

Prop

Type

Retrieve a paper

Retrieve a paper and check its status.

Read the paper graph

Load a paper's nodes in reading order and move between them.

On this page

List papersFilter papersPaginateOptions