Skip to main content

getById

client.workspace.getById(workspaceId: string): Promise<Workspace>

Retrieves a specific workspace by its unique identifier.

Returns detailed information about a single workspace including its settings, members, projects, and configuration metadata.

Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesThe unique identifier of the workspace to retrieve

Returns

Promise<Workspace> — A promise that resolves to the requested Workspace object

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.workspace.getById('workspaceId');
console.log(result);