Getting started

Paprwork provides a direct API to access data on paprwork.io. It lets you perform basic requests on a REST endpoint to index/show/create/update and destroy resources.

Resources

There a 3 types of resources available through the API :

Tenant

Tenant is the top-level container in Paprwork. It has many Work resources.
It is defined by a unique ID and a unique slug.
It can represent an organization, or a business unit, for example.

Work

Work belongs to a single Tenant resource.
It is defined by a unique ID and a unique slug.
It can be archived. It has many Request resources.
It represents a logical unit to separate Request resources. A Work can represent a group of Request relative to a file, for example.

Request

A Request is the main resource in Paprwork, it allows you to request data to a recipient.
Requests belong to a single Work resource, belong to a single recipient, and can have many documents attached.