List workspaces – GET /v1/workspaces

GET/v1/workspaces

betaapiKeyorganization

When to use

Discover the workspaces this API key can read.

For agents

Only explicitly readable workspaces are returned. Use an ID to derive a narrowed SDK client or X-Workspace-Id header.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const result = await orgClient.workspaces.list();

Response

json

{
  "data": {
    "items": [
      {
        "id": "wksp_finance123",
        "organizationId": "org_acme123",
        "name": "Finance",
        "context": "Revenue, customers, and operating performance",
        "visibility": "private",
        "createdAt": "2026-07-14T12:00:00.000Z",
        "updatedAt": "2026-07-14T12:00:00.000Z"
      }
    ]
  }
}