---
title: "listProjects"
description: "List projects"
canonical: "https://pgbeam.com/docs/ts-sdk/projects/listProjects"
last-updated: "2026-10-30T02:48:39.000Z"
---

# listProjects

> List projects

URL: https://pgbeam.com/docs/ts-sdk/projects/listProjects

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Lists projects filtered by organization. Requires org_id query parameter.

## Usage

```typescript
const result = await api.projects.listProjects({
  queryParams: { org_id: "org_abc123" },
});
```

## Parameters

| Parameter              | Type                                             | Required | Description                                            |
| ---------------------- | ------------------------------------------------ | -------- | ------------------------------------------------------ |
| queryParams.org_id     | `string`                                         | Yes      | Organization ID to filter projects.                    |
| queryParams.page_size  | `number`                                         | No       | Maximum number of items to return (1-100, default 20). |
| queryParams.page_token | `string`                                         | No       | Opaque token for cursor-based pagination.              |
| queryParams.sort_by    | `"name" \| "created_at" \| "active_connections"` | No       | Sort field for projects list.                          |

## Response

`Promise<ListProjectsResponse>`: list of projects.

## Example

```typescript
import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbu_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.projects.listProjects({
  queryParams: {
    org_id: "org_abc123",
    page_size: 20,
    page_token: "...",
    sort_by: "created_at",
  },
});
```

## Errors

| Status | Description                                                                                                                                                                                                                                                                                           |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.                                                                                                                                                                   |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status. |
| 429    | Rate limited. `code` is `RATE_LIMITED`.                                                                                                                                                                                                                                                               |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                        |