Paperless API Documentation
This is the complete API documentation for connecting to the Paperless API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Paperless: Paperless lets you create, send, track, and manage digital documents, templates, submissions, blobs, and webhook subscriptions. Keep reading to get started.
Quickstart
Before you run your first Paperless request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Paperless connection — create or choose one in Connections. Note its
connectionId.
Every Paperless action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/paperless/latest/actions/{actionSlug}You need a MindCloud API Key and a Paperless connection. Then call an action such as Get Document:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/paperless/latest/actions/get-document" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Paperless account that should run the action. MindCloud stores and refreshes the Paperless credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
Paperless actions
All 38 published actions for this Paperless version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Advanced Document
- POSTCreate Blob
- POSTCreate Blob For Attachment
- POSTCreate Blob For Image
- POSTCreate Blob For PDF
- POSTCreate Document
- POSTCreate Document Created Webhook
- POSTCreate Document From PDF
- POSTCreate Document From Template
- POSTCreate Document Updated Webhook
- POSTCreate Document With Email Content
- POSTCreate Document With Form Fields
- POSTCreate Document With Hidden Blocks
- POSTCreate Document With Redirect URL
- POSTCreate Document With Reminder Settings
- POSTCreate Document With Signature Fields
- POSTCreate Document With Variables
- POSTCreate Document With Visible Blocks
- POSTCreate Webhook
- DELETEDelete Document
- DELETEDelete Webhook
- GETGet Document
- GETGet Submission
- GETGet Template
- GETGet Webhook
- GETList Document Created Webhooks
- GETList Document Updated Webhooks
- GETList Documents
- GETList Submissions
- GETList Templates
- GETList Webhooks
- GETList Webhooks By Event
- PUTSet Document Email Content
- PUTUpdate Document
- PUTUpdate Document Block Visibility
- PUTUpdate Document Created Webhook
- PUTUpdate Document Updated Webhook
- PUTUpdate Webhook
Related apps
More apps on the Universal API, behind the same REST shape. Or browse all apps.