Folders

Folders organize decks inside an org. Grants on a folder cascade to everything in it, so a folder is also the unit of team access.

Related guides: Sharing & permissions

Attributes

idstringrequired
objectstringrequired
namestringrequired
parentstring | nullrequired
livemodebooleanrequired
metadataobjectrequired
Arbitrary key/value map; merge-on-write (§6).
trashed_attimestamprequired
created_attimestamprequired
updated_attimestamprequired

Endpoints

GET/v1/folders
POST/v1/folders
GET/v1/folders/{id}
PATCH/v1/folders/{id}
DELETE/v1/folders/{id}

The Folder object

{
  "id": "fld_7a2c…",
  "object": "folder",
  "name": "Clients",
  "parent": null,
  "livemode": true,
  "metadata": {},
  "trashed_at": null,
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}

List folders

GET/v1/folders

Lists folders at one level: children of `parent` (a folder id), or the root by default. `trashed=true` lists trashed folders.

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

Query parameters

parentstringoptional
trashedstringoptional
Possible values: true, false

Returns

200Folders at this level.

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

Terminal

renza folders list

GET /v1/folders

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

TypeScript

import { createRenzaClient } from "renza-sdk";

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

const page = await renza.folders.list();

Response 200

{
  "object": "list",
  "url": "/v1/decks",
  "data": [
    {
      "id": "fld_7a2c…",
      "object": "folder",
      "name": "Clients",
      "parent": null,
      "livemode": true,
      "metadata": {},
      "trashed_at": null,
      "created_at": "2026-06-19T10:30:00.000Z",
      "updated_at": "2026-06-19T10:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Create a folder

POST/v1/folders

Creates a folder, optionally under `parent_id` (omit/null for the root).

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

Body parameters

namestringoptionalmax 200 chars
parent_idstring | nulloptional

Returns

201The created folder.

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

Terminal

renza folders create Clients

POST /v1/folders

curl https://api.renza.io/v1/folders \
  -H "Authorization: Bearer $RENZA_API_KEY" \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Clients",
  "parent_id": null
}'

TypeScript

import { createRenzaClient } from "renza-sdk";

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

const folder = await renza.folders.create({
  name: "Clients",
  parent_id: null,
});

Response 201

{
  "id": "fld_7a2c…",
  "object": "folder",
  "name": "Clients",
  "parent": null,
  "livemode": true,
  "metadata": {},
  "trashed_at": null,
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}

Retrieve a folder

GET/v1/folders/{id}

Fetches a folder with its root→folder ancestry (for breadcrumbs).

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

Path parameters

idstringrequired

Returns

200The folder.

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

Terminal

renza folders get fld_7a2c…

GET /v1/folders/{id}

curl https://api.renza.io/v1/folders/fld_7a2c… \
  -H "Authorization: Bearer $RENZA_API_KEY"

TypeScript

import { createRenzaClient } from "renza-sdk";

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

const folder = await renza.folders.get("fld_7a2c…");

Response 200

{
  "id": "fld_7a2c…",
  "object": "folder",
  "name": "Clients",
  "parent": null,
  "livemode": true,
  "metadata": {},
  "trashed_at": null,
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}

Update a folder

PATCH/v1/folders/{id}

Rename (`name`), move (`parent_id`), or restore (`trashed: false`). Moving into a descendant or exceeding max depth is rejected.

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

Path parameters

idstringrequired

Body parameters

namestringoptionalmax 200 chars
parent_idstring | nulloptional
Move under this folder, or null for root.
trashedbooleanoptional
Set false to restore.

Returns

200The updated folder.

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

Terminal

renza folders rename fld_7a2c… "Active clients"

PATCH /v1/folders/{id}

curl https://api.renza.io/v1/folders/fld_7a2c… \
  -H "Authorization: Bearer $RENZA_API_KEY" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Active clients",
  "parent_id": "fld_9b…",
  "trashed": false
}'

TypeScript

import { createRenzaClient } from "renza-sdk";

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

const folder = await renza.folders.update("fld_7a2c…", {
  name: "Active clients",
  parent_id: "fld_9b…",
  trashed: false,
});

Response 200

{
  "id": "fld_7a2c…",
  "object": "folder",
  "name": "Clients",
  "parent": null,
  "livemode": true,
  "metadata": {},
  "trashed_at": null,
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}

Trash or permanently delete a folder

DELETE/v1/folders/{id}

Trashes the folder and its subtree (restore with `PATCH { trashed: false }`). `?permanent=true` permanently deletes an already-trashed folder + its contents (irreversible).

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

Path parameters

idstringrequired

Query parameters

permanentstringoptional
Possible values: true, false

Returns

200The trashed folder, or a deletion confirmation when `?permanent=true`.

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

Terminal

renza folders trash fld_7a2c…

DELETE /v1/folders/{id}

curl https://api.renza.io/v1/folders/fld_7a2c… \
  -H "Authorization: Bearer $RENZA_API_KEY" \
  -X DELETE

TypeScript

import { createRenzaClient } from "renza-sdk";

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

const folder = await renza.folders.trash("fld_7a2c…");

Response 200

{
  "id": "fld_7a2c…",
  "object": "folder",
  "name": "Clients",
  "parent": null,
  "livemode": true,
  "metadata": {},
  "trashed_at": null,
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}