Skip to main content

list

client.specs.list(params?: ListSpecsParams): Promise<Spec[]>

Lists all specification documents.

Returns every spec document in the system, optionally filtered by project, type, or other criteria. Use this for browsing specs or populating specification management UIs.

Parameters​

ParameterTypeRequiredDescription
paramsListSpecsParamsNoOptional query parameters for filtering specs

Returns​

Promise<Spec[]> — A promise that resolves to an array of Spec objects

Example​

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

const client = new CodeBoltClient();

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