Ist die API versioniert?

Ja. Die aktuelle Version ist v1. Breaking Changes werden in neuen Versionen eingeführt; das bestehende v1 bleibt stabil.

Gibt es Client-Bibliotheken?

Ja, für Node.js (papermark auf npm). Für andere Sprachen kann ein Client aus der OpenAPI-Spezifikation generiert werden.

Wo finde ich eine vollständige Endpunkt-Referenz?

Die Referenzdokumentation unter papermark.com/docs (https://www.papermark.com/docs) wird aus der OpenAPI-Spezifikation generiert.

Kann ich die API im kostenlosen Plan nutzen?

Nein. Die API erfordert den Business-Plan oder höher.

Unterstützt die API OAuth?

Ja. Die CLI und der MCP-Server verwenden OAuth 2.1 Device Flow für die Authentifizierung auf Benutzerebene. Für Backend-Integrationen sind API-Tokens in der Regel einfacher.

Was passiert, wenn ein Token kompromittiert wird?

Rotiere ihn sofort. Gehe zu Einstellungen, API-Tokens, klicke auf den betroffenen Token und widerrufe ihn. Alle Anfragen mit diesem Token werden ab sofort fehlschlagen.

Wie verwendet man die Papermark REST API?

Die Papermark REST API bietet dir programmatischen Zugriff auf alle Papermark-Ressourcen: Datenräume, Dokumente, Ordner, Links, Besucher und Analysen. Die gesamte Oberfläche basiert auf HTTPS, JSON und einem Bearer-Token – mit 43 Operationen über sechs Ressourcen und einer OpenAPI-Spezifikation, die die Dokumentation antreibt.

Die Papermark REST API ist im Business-Plan und höher verfügbar.

Was du mit der API machen kannst

Ressource	Operationen umfassen
Datenräume	Erstellen, auflisten, aktualisieren, löschen, Ordner verwalten
Dokumente	Hochladen, auflisten, suchen, abrufen, mit Datenräumen verknüpfen
Ordner	Erstellen, umbenennen, verschieben, löschen
Links	Passwortgeschützte oder ablaufende Links für Dokumente und Datenräume erstellen
Besucher	Auflisten, Verlauf pro Besucher abrufen
Analysen	Seitenweise Verweildauer, Abschluss, Downloads, Top-Seiten

Über die sechs Ressourcen hinweg stehen dir insgesamt 43 Operationen zur Verfügung. Die vollständige OpenAPI-Spezifikation liegt unter /docs/openapi.json und treibt die Dokumentationsseite an.

Schritt 1: Einen API-Token generieren

Melde dich bei Papermark an.
Gehe zu Einstellungen und dann zu API-Tokens.
Klicke auf Token erstellen.
Wähle Berechtigungen (nur lesen oder lesen/schreiben pro Ressource).
Kopiere den Token. Er beginnt mit pm_live_ und fungiert als langlebiges Bearer-Credential.

Behandle das Token wie ein Passwort. Speichere es in deinem Secrets Manager oder als Umgebungsvariable (PAPERMARK_TOKEN).

Begrenzte Token

Token sind auf bestimmte Berechtigungen beschränkt, sodass ein LLM-Agent nur Lesezugriff auf Dokumente haben kann, während dein CI-Job vollen Schreibzugriff besitzt. Wähle die minimalen Berechtigungen, die deine Integration benötigt.

Schritt 2: Deinen ersten Aufruf machen

export PAPERMARK_TOKEN=pm_live_AbCdEfGhIjKlMnOpQrStUvWxYz

curl https://api.papermark.com/v1/documents \
  -H "Authorization: Bearer $PAPERMARK_TOKEN"

Du erhältst eine JSON-Antwort mit deinen Dokumenten:

{
  "data": [{ "id": "doc_pitch_v4", "name": "Pitch Deck.pdf" }],
  "next_cursor": null
}

Häufige Workflows

Einen passwortgeschützten Link zu einem Datenraum erstellen

curl -X POST https://api.papermark.com/v1/links \
  -H "Authorization: Bearer $PAPERMARK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dataroom_id": "dr_8K2m",
    "password": "series-b-2026",
    "expires_at": "2026-06-10T00:00:00Z",
    "email_gate": true,
    "allow_download": false
  }'

Die Antwort enthält die eindeutige Link-URL, die sofort geteilt werden kann.

Seitenweise Analysen für eine Ansicht abrufen

curl https://api.papermark.com/v1/view-analytics/vw_3m9k \
  -H "Authorization: Bearer $PAPERMARK_TOKEN"

Gibt ein Payload zurück mit pages_viewed, completed, duration_ms, top_page und einem Array von page_durations_ms.

Ein Dokument hochladen (große Dateien)

Für Dateien über 10 MB verwende den S3-Presigned-Upload-Flow:

Eine Upload-URL anfordern: POST /v1/documents/upload-url
Die Datei direkt mit der zurückgegebenen Presigned URL zu S3 hochladen
Den Upload bestätigen: POST /v1/documents/confirm

Kein kompliziertes Streaming in deinem Code erforderlich.

Authentifizierung und Ratenlimits

Bearer-Token-Authentifizierung: Authorization: Bearer pm_live_... Header bei jeder Anfrage
Nur HTTPS: Anfragen über HTTP werden abgelehnt
Idempotenzschlüssel: Idempotency-Key: <uuid> für sichere Wiederholungsversuche bei POST-Anfragen übergeben
Paginierung: Listenendpunkte verwenden Cursor-Paginierung mit next_cursor zum Durchblättern der Ergebnisse
Ratenlimits: Standardlimits gelten je nach Tarif; kontaktiere den Support, wenn deine Integration höhere Limits benötigt

OpenAPI-Spezifikation und SDKs

Die vollständige Spezifikation ist unter /docs/openapi.json verfügbar. Du kannst Clients in jeder Sprache mit Tools wie openapi-typescript, openapi-python-client oder openapi-generator generieren.

openapi-typescript https://api.papermark.com/docs/openapi.json -o papermark.d.ts

Für Node.js ist ein SDK auf npm veröffentlicht:

npm install papermark

import { Papermark } from "papermark";

const pm = new Papermark({ apiKey: process.env.PAPERMARK_TOKEN });
const { data } = await pm.documents.list();

Webhooks für Echtzeit-Ereignisse

Die API bietet dir Pull-Zugriff. Für Push-Ereignisse (Link aufgerufen, Dokument hochgeladen, Link erstellt) verwende Webhooks. Sie ergänzen die API ideal für ereignisgesteuerte Integrationen.

Anwendungsfälle

CRM-Synchronisierung: Wenn ein neuer Betrachter einen Link öffnet, wird ein Datensatz in HubSpot oder Salesforce übertragen.
Investor-Outreach: Personalisierte Links für jeden Investor programmatisch erstellen und per E-Mail versenden.
Reporting-Dashboards: Besucher- und Analysedaten in dein Data Warehouse oder BI-Tool übertragen.
Automatisierte Datenraum-Bereitstellung: Einen Datenraum mit einer Ordnerstruktur aus einem CI-Job aufsetzen.
KI-Agenten: Die API mit dem MCP-Server kombinieren, damit Agenten wie Claude auf Papermark-Ressourcen zugreifen können.