---
title: "listOrgInvitations"
description: "List invitations"
canonical: "https://pgbeam.com/docs/ts-sdk/account/listOrgInvitations"
last-updated: "2026-10-22T11:48:14.000Z"
---

# listOrgInvitations

> List invitations

URL: https://pgbeam.com/docs/ts-sdk/account/listOrgInvitations

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

Lists invitations to join the organization and where each has got to.

## Usage

```typescript
const result = await api.account.listOrgInvitations({
  pathParams: { org_id: "org_abc123" },
});
```

## Parameters

| Parameter              | Type                                                  | Required | Description                                               |
| ---------------------- | ----------------------------------------------------- | -------- | --------------------------------------------------------- |
| pathParams.org_id      | `string`                                              | Yes      | Unique organization identifier.                           |
| queryParams.status     | `"pending" \| "accepted" \| "rejected" \| "canceled"` | No       | Filter to a single status. Omit to list every invitation. |
| 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<ListOrgInvitationsResponse>`: a page of invitations.

## Example

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

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

const result = await client.api.account.listOrgInvitations({
  pathParams: { org_id: "org_abc123" },
  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`.                                                                                                                                                                                                                                                               |