List objects in a bucket | Neon Postgres Docs

GET/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objectsList objects in a bucket

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.

Parameters

project_idstringpathrequired

The Neon project ID

pattern ^[a-z0-9-]{1,60}$

branch_idstringpathrequired

The Neon branch ID

pattern ^[a-z0-9-]{1,60}$

bucket_namestringpathrequired

The bucket name

maxLength 255 · minLength 1

prefixstringquery

Only list objects whose key starts with this prefix.

delimiterstringquery

Collapse keys sharing a common prefix up to the first occurrence of this delimiter (typically `/`) into the `folders` array.

cursorstringquery

Opaque pagination cursor returned as `next_cursor` by a previous call. Resume listing after the last item of the previous page.

limitinteger · int32query

Maximum number of items (objects + folders) to return.

default 1000 · maximum 1000 · minimum 1

Responses

objectBucketObjectsListResponse

foldersarray of stringrequired

Common prefixes (folder names) collapsed under the requested `delimiter`. Empty when no `delimiter` was supplied.

Show child attributes

is_truncatedbooleanrequired

True when more results exist beyond this page.

next_cursorstring

Pagination cursor to pass as `cursor` on the next request. Empty when the listing is not truncated.

objectsarray of objectrequired

Objects whose keys did not collapse into a folder.

Show child attributes

Show array items

etagstringrequired

The object's entity tag (content hash).

keystringrequired

The full object key.

last_modifiedstring · date-timerequired

The time the object was last modified.

sizeinteger · int64required

The object size in bytes.

prefixstringrequired

The prefix that was applied to this listing (echoed back).

Example response

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

defaultGeneral 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

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

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

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

bucket_namerequiredpath parameter

prefixquery parameter

delimiterquery parameter

cursorquery parameter

limitquery parameter

curl -X GET 'https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects?cursor=string&delimiter=string&limit=1000&prefix=string'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects?cursor=string&delimiter=string&limit=1000&prefix=string', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects?cursor=string&delimiter=string&limit=1000&prefix=string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects?cursor=string&delimiter=string&limit=1000&prefix=string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects?cursor=string&delimiter=string&limit=1000&prefix=string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects?cursor=string&delimiter=string&limit=1000&prefix=string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects?cursor=string&delimiter=string&limit=1000&prefix=string"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects?cursor=string&delimiter=string&limit=1000&prefix=string")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects?cursor=string&delimiter=string&limit=1000&prefix=string");
using var response = await client.SendAsync(request);

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

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