Orgs & memberships

The tenancy spine. Every request acts within exactly one org; API keys are org-bound, and sessions choose the active org with the `Renza-Org` header. Memberships list who belongs to the active org.

Attributes

idstringrequired
objectstringrequired
namestringrequired
typestringrequired
Possible values: personal, team
metadataobjectrequired
Arbitrary key/value map; merge-on-write (§6).
created_attimestamprequired
updated_attimestamprequired

Endpoints

GET/v1/orgs
GET/v1/orgs/{id}
PATCH/v1/orgs/{id}
GET/v1/memberships

The Org object

{
  "id": "org_3Fy…",
  "object": "org",
  "name": "Paul's workspace",
  "type": "personal",
  "metadata": {},
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}

List orgs

GET/v1/orgs

Lists the orgs the credential can act on. A key is bound to one org, so this returns it.

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

Returns

200The accessible org(s).

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

Terminal

renza orgs list

GET /v1/orgs

curl https://api.renza.io/v1/orgs \
  -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.orgs.list();

Response 200

{
  "object": "list",
  "url": "/v1/decks",
  "data": [
    {
      "id": "org_3Fy…",
      "object": "org",
      "name": "Paul's workspace",
      "type": "personal",
      "metadata": {},
      "created_at": "2026-06-19T10:30:00.000Z",
      "updated_at": "2026-06-19T10:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Retrieve an org

GET/v1/orgs/{id}

Fetches an org by id. Only the credential's active org is accessible.

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

Path parameters

idstringrequired

Returns

200The org.

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

Terminal

renza orgs get org_3Fy…

GET /v1/orgs/{id}

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

TypeScript

import { createRenzaClient } from "renza-sdk";

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

const org = await renza.orgs.get("org_3Fy…");

Response 200

{
  "id": "org_3Fy…",
  "object": "org",
  "name": "Paul's workspace",
  "type": "personal",
  "metadata": {},
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}

Update an org

PATCH/v1/orgs/{id}

Partial update of the active org (name; `metadata` merges per §6).

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

Path parameters

idstringrequired

Body parameters

namestringoptionalmax 200 chars
metadataobjectoptional
Arbitrary key/value map; merge-on-write (§6).

Returns

200The updated org.

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

Terminal

renza orgs update org_3Fy… --name "Acme Inc."

PATCH /v1/orgs/{id}

curl https://api.renza.io/v1/orgs/org_3Fy… \
  -H "Authorization: Bearer $RENZA_API_KEY" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme Inc."
}'

TypeScript

import { createRenzaClient } from "renza-sdk";

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

const org = await renza.orgs.update("org_3Fy…", {
  name: "Acme Inc.",
});

Response 200

{
  "id": "org_3Fy…",
  "object": "org",
  "name": "Paul's workspace",
  "type": "personal",
  "metadata": {},
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}

List memberships

GET/v1/memberships

Lists the members of the credential's active org.

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

Returns

200The active org's memberships.

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

Terminal

renza memberships

GET /v1/memberships

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

TypeScript

import { createRenzaClient } from "renza-sdk";

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

const org = await renza.memberships.list();

Response 200

{
  "object": "list",
  "url": "/v1/decks",
  "data": [
    {
      "id": "mem_9aB…",
      "object": "membership",
      "user": "usr_2c4…",
      "org": "org_3Fy…",
      "role": "owner",
      "created_at": "2026-06-19T10:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}