Skip to main content

get

client.specs.get(params?: GetSpecParams): Promise<Spec>

Retrieves a specific specification document.

Returns the spec matching the provided query parameters, typically by spec ID or project. The document includes all sections, metadata, and version information.

Parameters​

ParameterTypeRequiredDescription
paramsGetSpecParamsNoQuery parameters to identify the spec

Returns​

Promise<Spec> — A promise that resolves to the Spec object

Example​

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

const client = new CodeBoltClient();

const result = await client.specs.get();
console.log(result);