List objects in a bucket

GET /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objectsbeta

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.

Markdown for AI context

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/buckets/$BUCKET_NAME/objects" \
  -H "Authorization: Bearer $NEON_API_KEY"

Every field below is optional. An empty body works too.

Also available in

neon buckets object list <branch_id>

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The Neon branch ID

Bucket name

bucket_name

string

The bucket name

Prefix

prefix

string

Only list objects whose key starts with this prefix.

Delimiter

delimiter

string

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

Cursor

cursor

string

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

Limit

limit

integerdefault: 1000

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

200

The list of objects and folders

"folders": (array),req

"prefix": (string),req

"is_truncated": (boolean),req

"next_cursor": (string),

default

General error

This endpoint can return the standard Neon API error response.

Response fields

• message Required. Human-readable error message.
• code Required. Machine-readable error code.
• request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.