Skip to main content

listProjects()

listProjects(options?: ListProjectsOptions): Promise<ListProjectsResponse>

Defined in: packages/core/src/index.ts:1974

List all projects for the current user

Parameters

ParameterTypeDescription
options?ListProjectsOptionsPagination and filter options (page, limit, search)

Returns

Promise<ListProjectsResponse>

Paginated list of projects

Throws

401 - Not authenticated

Example

import { listProjects } from "@cpod/sdk";

const response = await listProjects({ page: 1, limit: 10 });
console.log(`Found ${response.total} projects`);

response.projects.forEach(project => {
console.log(`${project.name} - ${project.description}`);
});