Decks

The governed document. A deck owns its artifact versions, its share state, and its lifecycle status (draft → in review → published → archived). State transitions are field updates — publish a deck by setting `status`, not by calling a verb.

Related guides: Import a deck · Sharing & permissions

Attributes

idstringrequired
objectstringrequired
titlestringrequired
statusstringrequired
current_artifactstring | nullrequired
share_modestringrequired
external_idstring | nullrequired
folderstring | nullrequired
livemodebooleanrequired
metadataobjectrequired
Arbitrary key/value map; merge-on-write (§6).
trashed_attimestamprequired
created_attimestamprequired
updated_attimestamprequired

Endpoints

The Deck object

{
  "id": "deck_2a9f8c1b",
  "object": "deck",
  "title": "Q3 Board Deck",
  "status": "draft",
  "current_artifact": "art_7c1b…",
  "share_mode": "private",
  "external_id": "q3-board-deck",
  "folder": "fld_7a2c…",
  "livemode": true,
  "metadata": {},
  "trashed_at": null,
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}