Shares · API reference

API reference

Link access to a deck. A share mints a token URL; anyone with the link gets the deck's public surface. For person-level access with roles, use grants instead.

Related guides: Sharing & permissions

Attributes

idstringrequired
objectstringrequired
tokenstringrequired
deckstringrequired
modestringrequired
Possible values: link, public
urlstringrequired
expires_attimestamprequired
revoked_attimestamprequired
created_attimestamprequired

Endpoints

GET/v1/shares
POST/v1/shares
DELETE/v1/shares/{id}
GET/v1/public/shares/{token}

The Share object

{
  "id": "shr_7a2c…",
  "object": "share",
  "token": "X3k9...x",
  "deck": "deck_2a9f8c1b",
  "mode": "link",
  "url": "https://renza.io/v/X3k9…x",
  "expires_at": null,
  "revoked_at": null,
  "created_at": "2026-06-19T10:30:00.000Z"
}