---
title: "listApprovalRequests"
description: "List approval requests"
canonical: "https://pgbeam.com/docs/ts-sdk/approvals/listApprovalRequests"
last-updated: "2026-10-29T19:01:20.000Z"
---

# listApprovalRequests

> List approval requests

URL: https://pgbeam.com/docs/ts-sdk/approvals/listApprovalRequests

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

Lists approval requests for the project, newest first, optionally filtered by status.

## Usage

```typescript
const result = await api.approvals.listApprovalRequests({
  pathParams: { project_id: "prj_xxx" },
});
```

## Parameters

| Parameter              | Type                                                                           | Required | Description                                            |
| ---------------------- | ------------------------------------------------------------------------------ | -------- | ------------------------------------------------------ |
| pathParams.project_id  | `string`                                                                       | Yes      | Unique project identifier (prefixed, e.g. prj_xxx).    |
| queryParams.status     | `"pending" \| "approved" \| "rejected" \| "expired" \| "executed" \| "failed"` | No       | Filter to a single status.                             |
| 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.              |

## Response

`Promise<ListApprovalRequestsResponse>`: page of approval requests.

## Example

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

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

const result = await client.api.approvals.listApprovalRequests({
  pathParams: { project_id: "prj_xxx" },
  queryParams: { status: "open", page_size: 20, page_token: "..." },
});
```

## 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. |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                                                                                                                                                                                               |
| 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.                                                                                                                                                                                        |