# List objects in a bucket

**GET** `/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects`

Lists objects visible in the named bucket on the specified branch,
including those inherited from ancestor branches. Listing is served by
the user's session (no customer S3 credentials required).

When `delimiter` is supplied (typically `/`), keys are collapsed into
common prefixes (`folders`) so callers can render a folder-style
browser; keys that do not contain the delimiter after `prefix` are
returned as `objects`.

**Note**: This endpoint is currently in Beta.

Base URL: `https://console.neon.tech/api/v2`

Tags: `Buckets`

## Authorization

Any ONE of the following options authorizes this operation; every scheme listed within an option is required together.

| Option | Scheme | Type | Sent as | Scopes |
| --- | --- | --- | --- | --- |
| Option 1 | `BearerAuth` | `http` | `Authorization: Bearer <token>` | — |
| Option 2 | `CookieAuth` | `apiKey` | cookie `zenith` | — |
| Option 3 | `TokenCookieAuth` | `apiKey` | cookie `keycloak_token` | — |

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `project_id` | `string` | Yes | The Neon project ID |
| `branch_id` | `string` | Yes | The Neon branch ID |
| `bucket_name` | `string` | Yes | The bucket name |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `prefix` | `string` | No | Only list objects whose key starts with this prefix. |
| `delimiter` | `string` | No | Collapse keys sharing a common prefix up to the first occurrence of this delimiter (typically `/`) into the `folders` array. |
| `cursor` | `string` | No | Opaque pagination cursor returned as `next_cursor` by a previous call. Resume listing after the last item of the previous page. |
| `limit` | `integer` (int32) | No | Maximum number of items (objects + folders) to return. |

## Responses

| Status | Description | Media type |
| --- | --- | --- |
| `200` | The list of objects and folders | `application/json` |
| `default` | General Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. | `application/json` |

### Example response: 200 — The list of objects and folders

```json
{
  "folders": [
    "string"
  ],
  "is_truncated": true,
  "next_cursor": "string",
  "objects": [
    {
      "etag": "string",
      "key": "string",
      "last_modified": "2026-06-09T00:00:00Z",
      "size": 0
    }
  ],
  "prefix": "string"
}
```

### Example response: default — General Error.

The request may or may not be safe to retry, depending on the HTTP method, response status code,
and whether a response was received.

- If no response is returned from the API, a network error or timeout likely occurred.
- In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.

The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**.
The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout.

Any request that returns a `503 Service Unavailable` response is always safe to retry.

Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.

```json
{
  "code": "",
  "message": "string",
  "request_id": "string"
}
```

## Related pages

- [Accept a project transfer request](./acceptprojecttransferrequest.md)
- [Add an OAuth provider](./addneonauthoauthprovider.md)
- [Add an OAuth provider](./addbranchneonauthoauthprovider.md)
- [Add domain to redirect_uri whitelist](./addbranchneonauthtrusteddomain.md)
- [Add JWKS URL](./addprojectjwks.md)
- [Add trusted redirect URI domain](./addneonauthdomaintoredirecturiwhitelist.md)
- [AI Gateway](./tags/ai-gateway.md)
- [API Key](./tags/api-key.md)
- [Assign or update VPC endpoint](./assignorganizationvpcendpoint.md)
- [Auth](./tags/auth.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.