PapermarkDocs

links

Create, list, get, and delete share links.

A link is the public-facing URL someone uses to view a document or dataroom. Links carry their own access controls (password, email gating, expiry, download permission) — the document or dataroom behind them just sits there.

list

papermark links list [--document <id>] [--dataroom <id>] [--limit <n>] [--cursor <id>]

Lists share links. Filter by document or dataroom, or omit both for all links.

FlagDefaultEffect
--document <id>Only links pointing at this document
--dataroom <id>Only links pointing at this dataroom
-l, --limit <n>25Page size, 1–100
-c, --cursor <id>Continuation cursor
papermark links list --document doc_aBc123

For dataroom-bound links specifically, papermark datarooms links <id> is an ergonomic equivalent that takes the dataroom ID positionally instead of as a flag.

get

papermark links get <id>

Fetches one link by ID. Includes its access controls but not the view history — use views list for that.

create

papermark links create \
  (--document <id> | --dataroom <id>) \
  [--name <name>] \
  [--password <password>] \
  [--expires <iso-8601>] \
  [--email-protected] \
  [--allow-download]

Either --document or --dataroom is required (exactly one).

FlagDefaultEffect
--document <id>Document to share
--dataroom <id>Dataroom to share
-n, --name <name>autoInternal label
--password <pw>noneViewer must enter this password
--expires <iso>neverISO 8601 datetime, e.g. 2026-12-31T00:00:00Z
--email-protectedoffViewer must enter their email before viewing
--allow-downloadoffViewer can download the file (default is view-only)
$ papermark links create \
    --document doc_KlmN456 \
    --password "open-sesame" \
    --expires 2026-12-31T00:00:00Z \
    --email-protected
ID:    link_abcd1234
URL:   https://papermark.com/view/abcd1234efgh

delete

papermark links delete <id>

Revokes the link. The URL stops working immediately; existing viewers in flight see an "expired" page on the next request.

Required scopes

CommandScope
list, getlinks.read
create, deletelinks.write

For dataroom-bound links, you also need datarooms.read on the referenced dataroom.

On this page