---
title: "listReplicas"
description: "List replicas"
canonical: "https://pgbeam.com/docs/ts-sdk/projects/listReplicas"
last-updated: "2026-09-14T19:37:21.000Z"
---

# listReplicas

> List replicas

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

Lists a database's read replicas.

## Usage

## Parameters

Parameter

Type

Required

Description

pathParams.database\_id

`string`

Yes

Unique database identifier (prefixed, e.g. db\_xxx).

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<ListReplicasResponse>`: list of replicas.

## Example

## 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.