--- title: "List bouncers" method: GET path: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers" tags: ["Bouncers"] --- # List bouncers `GET /organizations/{organization}/databases/{database}/branches/{branch}/bouncers` ### 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 ## Response `200` Returns bouncers - 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 bouncer - `name` string, required — The name of the bouncer - `sku` object, required - `name` string, required — The name of the Postgres bouncer SKU - `display_name` string, required — The display name - `cpu` string, required — The CPU allocation - `ram` integer, required — The amount of memory in bytes - `sort_order` integer, required — The sort order of the Postgres bouncer SKU - `target` 'primary' | 'replica' | 'replica_az_affinity', required — The instance type the bouncer targets - `replicas_per_cell` integer, required — The count of replicas in each cell - `created_at` string, required — When the bouncer was created - `updated_at` string, required — When the bouncer was updated - `deleted_at` string, nullable, required — When the bouncer was deleted - `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 - `branch` 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 - `parameters` object[], required - `id` string, required — The ID of the parameter - `namespace` 'pgbouncer', required — The namespace of the parameter - `name` string, required — The name of the parameter - `display_name` string, required — The display name of the parameter - `category` string, required — The category of the parameter - `description` string, required — The description of the parameter - `immutable` boolean, required — Whether the parameter can be changed - `parameter_type` 'array' | 'integer' | 'seconds' | 'select' | 'string', required — The type of the parameter - `default_value` string, required — The default value of the parameter - `value` string, required — The configured value of the parameter - `required` boolean, required — Whether the parameter is required - `created_at` string, required — When the parameter was created - `updated_at` string, required — When the parameter was last updated - `restart` boolean, required — True if processes require a server restart on change - `max` number, required — The maximum value of the parameter - `min` number, required — The minimum value of the parameter - `url` string, required — The URL of the parameter - `options` string[], required — Valid options for the parameter value - `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 ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `500` — Internal Server Error ## Changes - **2026-08-18** `249942995489` — 1 breaking - removed the required property `data/items/parameters/items/step` from the response with the `200` status - **2026-08-11** `4b2e4f05bda2` — 1 info - added the required property `per_page` to the response with the `200` status - **2026-06-01** `72506953f367` — 6 breaking, 1 info - the response property `data/items/branch/deleted_at` became nullable for the status `200` - the response property `data/items/deleted_at` became nullable for the status `200` - the response property `next_page` became nullable for the status `200` - the response property `next_page_url` became nullable for the status `200` - …3 more - **2026-02-24** `3c33e46f8ff2` — 1 warning, 2 info - added the new `string` enum value to the `data/items/parameters/items/parameter_type` response property for the response status `200` - removed the `internal` enum value from the `data/items/parameters/items/parameter_type` response property for the response status `200` - added the required property `data/items/parameters/items/immutable` to the response with the `200` status - …earlier changes not shown [Full history](https://skmtc.dev/planetscale/apis/planetscale-api/changes/organizations/:organization/databases/:database/branches/:branch/bouncers/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)