---
title: "Get read-only replica change requests"
method: GET
path: "/organizations/{organization}/databases/{database}/branches/{branch}/read-only-replica-changes"
tags: ["api-read_only_replica_changes"]
---

# Get read-only replica change requests

`GET /organizations/{organization}/databases/{database}/branches/{branch}/read-only-replica-changes`

### Authorization
A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

**Service Token Accesses**
 `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`

**OAuth Scopes**

 | Resource | Scopes |
| :------- | :---------- |
| Organization | `read_branches` |
| Database | `read_branches` |
| Branch | `read_branch` |

## Path parameters

- `organization` string, required
- `database` string, required
- `branch` string, required

## Query parameters

- `page` integer
- `per_page` integer
- `period` '15m' | '1h' | '3h' | '6h' | '12h' | '1d' | '2d' | '7d' | '8d'
- `completed_at` string

## Response `200`

Returns read-only replica change requests

- object
  - `type` string, required — The response type. Always "list" for paginated responses.
  - `current_page` integer, required — The current page number
  - `per_page` integer, required — The maximum number of results per page
  - `next_page` integer, nullable, required — The next page number, or null when this is the last page
  - `next_page_url` string, nullable, required — The next page of results, or null when this is the last page
  - `prev_page` integer, nullable, required — The previous page number, or null when this is the first page
  - `prev_page_url` string, nullable, required — The previous page of results, or null when this is the first page
  - `data` object[], required
    - `id` string, required — The ID of the read-only replica change request
    - `state` 'pending' | 'resizing' | 'canceled' | 'completed', required — The state of the change request
    - `cluster_name` string, required — The new cluster size SKU
    - `cluster_display_name` string, required — The new cluster size for display
    - `cluster_rank` integer, required — The new cluster size sort order
    - `replicas` integer, required — The new instance count
    - `parameters` object, required — The new parameters
    - `previous_cluster_name` string, required — The previous cluster size SKU
    - `previous_cluster_display_name` string, required — The previous cluster size for display
    - `previous_cluster_rank` integer, required — The previous cluster size sort order
    - `previous_replicas` integer, required — The previous instance count
    - `previous_parameters` object, required — The previous parameters
    - `started_at` string, nullable, required — When the change started
    - `completed_at` string, nullable, required — When the change completed
    - `created_at` string, required — When the change request was created
    - `updated_at` string, required — When the change request was last updated
    - `actor` object, required
      - `id` string, required — The ID of the actor
      - `display_name` string, required — The name of the actor
      - `avatar_url` string, required — The URL of the actor's avatar
    - `replica` object, required
      - `id` string, required — The ID for the resource
      - `name` string, required — The name for the resource
      - `created_at` string, required — When the resource was created
      - `updated_at` string, required — When the resource was last updated
      - `deleted_at` string, nullable, required — When the resource was deleted, if deleted

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

## Changes

- **2026-08-28** `6d28c038c4fd` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/planetscale/apis/planetscale-api/changes/organizations/:organization/databases/:database/branches/:branch/read-only-replica-changes/get.md)

---

[API](https://skmtc.dev/planetscale/apis/planetscale-api.md) · [All operations](https://skmtc.dev/planetscale/apis/planetscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/planetscale/planetscale-api/revisions/6d28c038c4fd/schema)