Get a workspace – GET /v1/workspaces/{workspaceId}

GET/v1/workspaces/{workspaceId}

betaapiKeyorganization

When to use

Read the current name, context, and visibility of one workspace.

For agents

Use an exact workspace ID returned by create or list. The key needs read access to it.

Example

typescript

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

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

const result = await orgClient.workspaces.get('wksp_finance123');

Response

json

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