Skip to main content

Function: listProjects()

listProjects(client, props): Promise<{ rows: object[]; rowCount: number; }>

Lists projects with optional filtering and pagination.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

query​

{ pageOffset?: number; pageSize?: number; sortBy?: "name" | "createdAt" | "updatedAt"; sortDir?: "asc" | "desc"; visibility?: "PRIVATE" | "PUBLIC"; userName?: string; orgName?: string; } = listProjectsQuerySchema

Query parameters for filtering, pagination, and sorting

query.pageOffset?​

number = ...

query.pageSize?​

number = ...

query.sortBy?​

"name" | "createdAt" | "updatedAt" = ...

query.sortDir?​

"asc" | "desc" = ...

query.visibility?​

"PRIVATE" | "PUBLIC" = ...

query.userName?​

string = ...

query.orgName?​

string = ...

Returns​

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of projects

Operation Id​

list-projects-in-org

Example​

const projects = await listProjects(client, {
  query: { orgName: 'my-org', visibility: 'PUBLIC', pageOffset: 0, pageSize: 20 }
});