Documents

#Who you are: the signed-in person and what they can do here

Address

https://<your-org>.brambleit.cloud/paper/api/me

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Response 200

{
  "user": {
    "id": 42,
    "name": "Example name",
    "first_name": "Alex",
    "email": "alex@example.com"
  },
  "cabinets": [],
  "tags": [],
  "correspondents": [],
  "doctypes": [],
  "inbox": null,
  "locked": null,
  "views": [
    {
      "id": 42,
      "name": "Example name",
      "filters": []
    }
  ]
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/me', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Search and list documents

Address

https://<your-org>.brambleit.cloud/paper/api/documents

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Query parameters

Response 200

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Get a document

Address

https://<your-org>.brambleit.cloud/paper/api/documents/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Response 200

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/42', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Update a document

Address

https://<your-org>.brambleit.cloud/paper/api/documents/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Request body JSON

Response 200

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/42', {
  method: 'PATCH',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"title":"Example title","date":"2026-11-12","correspondent_id":7,"doctype_id":7,"notes":"string","asn":"string","tag_ids":[]}),
});
const data = await res.json();

#Delete a document

Address

https://<your-org>.brambleit.cloud/paper/api/documents/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Response 200

{
  "ok": true
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/42', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

#Change many documents at once

Address

https://<your-org>.brambleit.cloud/paper/api/documents/bulk

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Request body JSON

Response 200

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/bulk', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"all":"…","filters":[],"ids":[],"op":"string","value":"…"}),
});
const data = await res.json();

#Read a document's text again

Address

https://<your-org>.brambleit.cloud/paper/api/documents/:id/reprocess

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Response 200

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/12.5/reprocess', {
  method: 'POST',
  credentials: 'include',
});
const data = await res.json();

#The file itself, streamed from Drive (Range passed on, for PDF.js)

Address

https://<your-org>.brambleit.cloud/paper/api/documents/:id/file

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Query parameters

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/42/file', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Unlock a password-protected PDF

Address

https://<your-org>.brambleit.cloud/paper/api/documents/:id/unlock

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Request body JSON

Response 200

{
  "ok": true,
  "retried": null
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/42/unlock', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"password":"…","remember":"…","label":"Example label"}),
});
const data = await res.json();

#A document's thumbnail

Address

https://<your-org>.brambleit.cloud/paper/api/documents/:id/thumb

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Response

An empty body, a body.

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/42/thumb', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Sharing is Drive's: links (with expiry, password, download switch) and people/groups

Address

https://<your-org>.brambleit.cloud/paper/api/documents/:id/sharing

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Response 200

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/42/sharing', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Create a share link

Address

https://<your-org>.brambleit.cloud/paper/api/documents/:id/links

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Request body JSON

Response 200

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/42/links', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"expires_days":1,"password":"…","allow_download":false}),
});
const data = await res.json();

#Delete a share link

Address

https://<your-org>.brambleit.cloud/paper/api/documents/:id/links/:lid

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Response 200

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/documents/42/links/12.5', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

#Add a document

Address

https://<your-org>.brambleit.cloud/paper/api/upload

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Query parameters

Response duplicate ? 200 : 201

{
  "…await documents.get(req.": "…",
  "duplicate": null
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/upload', {
  method: 'POST',
  credentials: 'include',
});
const data = await res.json();

#Save a view (filters)

Address

https://<your-org>.brambleit.cloud/paper/api/views

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Request body JSON

Response 201

{
  "id": 42
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/views', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","filters":[]}),
});
const data = await res.json();

#Delete a saved view

Address

https://<your-org>.brambleit.cloud/paper/api/views/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Paper.

Path parameters

Response 200

{
  "ok": true
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/paper/api/views/12.5', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();