Retrieve a deck

GET/v1/decks/{id}

Fetches a deck by Renza id or by `external_id` within the active org.

Requires an API key (bearer), scoped to the active org.

Path parameters

idstringrequired

Returns

200The deck.

Failures use the standard error envelope with a closed set of codes.

Terminal

renza decks get deck_2a9f8c1b

GET /v1/decks/{id}

curl https://api.renza.io/v1/decks/deck_2a9f8c1b \
  -H "Authorization: Bearer $RENZA_API_KEY"

TypeScript

import { createRenzaClient } from "renza-sdk";

const renza = createRenzaClient({ apiKey: process.env.RENZA_API_KEY! });

const deck = await renza.decks.get("deck_2a9f8c1b");

Response 200

{
  "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"
}