Paper API
Bramble Paper: document management on top of Drive. Cabinets (Drive libraries), documents with recognised text, labels (tags, correspondents, document types), saved views, bulk changes, locked PDFs, and mail intake rules that file attachments automatically.
- Address
https://<your-org>.brambleit.cloud/paper- Sign-in
- Signed-in browser session (the
sso_session/session_idcookies from Bramble sign-in). - Endpoints
- 38
- OpenAPI
- paper.json
- Guides
- How Paper works
Signing in
These endpoints use a signed-in browser session. From your own systems, use Flows webhooks and Bramble steps, or the main API with an API key. See Calling the API.
Documents are Drive files. A cabinet is a Drive library; Paper adds the text, labels and dates. Sharing is Drive's sharing.
Labels come in three kinds — tags, correspondents and doctypes —
and can belong to one cabinet or all of them. Each can be set by a matching
rule or learnt automatically.
Resources
Documents
Searching and listing documents, one document, its file and thumbnail, editing, bulk changes, reprocessing, locked PDFs, sharing links, and saved views.
| Method | Path | Summary |
|---|---|---|
| GET | /api/me | Who you are: the signed-in person and what they can do here |
| GET | /api/documents | Search and list documents |
| GET | /api/documents/:id | Get a document |
| PATCH | /api/documents/:id | Update a document |
| DELETE | /api/documents/:id | Delete a document |
| POST | /api/documents/bulk | Change many documents at once |
| POST | /api/documents/:id/reprocess | Read a document's text again |
| GET | /api/documents/:id/file | The file itself, streamed from Drive (Range passed on, for PDF.js) |
| POST | /api/documents/:id/unlock | Unlock a password-protected PDF |
| GET | /api/documents/:id/thumb | A document's thumbnail |
| GET | /api/documents/:id/sharing | Sharing is Drive's: links (with expiry, password, download switch) and people/groups |
| POST | /api/documents/:id/links | Create a share link |
| DELETE | /api/documents/:id/links/:lid | Delete a share link |
| POST | /api/upload | Add a document |
| POST | /api/views | Save a view (filters) |
| DELETE | /api/views/:id | Delete a saved view |
Cabinets
Cabinets (from Drive libraries), their folder templates, watching Drive for new files, and saved passwords for locked PDFs.
| Method | Path | Summary |
|---|---|---|
| GET | /api/cabinets | List cabinets |
| GET | /api/cabinets/libraries | Drive libraries that could become cabinets |
| POST | /api/cabinets | Make a library a cabinet |
| PATCH | /api/cabinets/:id | Update a cabinet |
| DELETE | /api/cabinets/:id | Stop using a library as a cabinet |
| GET | /api/cabinets/:id/passwords | Saved passwords for locked PDFs (labels only — never the passwords back) |
| POST | /api/cabinets/:id/passwords | Save a password for locked PDFs |
| DELETE | /api/cabinets/:id/passwords/:pid | Delete a saved password |
Labels
Tags, correspondents and document types, with their matching rules.
| Method | Path | Summary |
|---|---|---|
| GET | /api/labels/:kind | List labels |
| POST | /api/labels/:kind | Create a label |
| PATCH | /api/labels/:kind/:id | Update a label |
| DELETE | /api/labels/:kind/:id | Delete a label |
Mail intake
Mailboxes Paper checks, and the rules that file their attachments into cabinets.
| Method | Path | Summary |
|---|---|---|
| GET | /api/mail | Mail accounts and rules |
| POST | /api/mail/accounts | Add a mailbox to check |
| PATCH | /api/mail/accounts/:id | Update a mailbox |
| DELETE | /api/mail/accounts/:id | Remove a mailbox |
| POST | /api/mail/accounts/:id/test | Signs in and returns the folders |
| POST | /api/mail/accounts/:id/check | Check a mailbox now |
| POST | /api/mail/rules | Create a mail rule |
| PATCH | /api/mail/rules/:id | Update a mail rule |
| DELETE | /api/mail/rules/:id | Delete a mail rule |
Share to Paper
Where "Share to Paper" from a phone lands.
| Method | Path | Summary |
|---|---|---|
| POST | /share | "Share to Paper" from a phone lands here only if the service worker (which normally takes the files) isn't installed yet: just open the app |
Web pages
These return pages for the browser rather than data.
GET /GET /sw.js