List buckets

GET/v1/bucketsList buckets

Returns all object-store buckets the token has access to. Optionally filter by project ID.

Parameters

cursornull | stringquery

Cursor for pagination

limitintegerquery

Page size, 1-100

default 100 · maximum 100 · minimum 1

projectIdstringquery

Filter buckets by project ID

pattern ^(proj_)?([cC][^\s-]{8,}|[a-z0-9]+)$

logicalIdstringquery

Declared identity of the resource, unique within its branch. Set by the tool that declares the resource.

maxLength 255 · pattern ^[A-Za-z0-9][A-Za-z0-9._-]*$

branchIdvaluequery

anyOf · 2 options

Option 1string

const "unassigned"

Option 2string

pattern ^(br_)?([cC][^\s-]{8,}|[a-z0-9]+)$

branchGitNamestringquery

minLength 1

Responses

object

dataarray of objectrequired

Show child attributes

Show array items

branchIdnull | stringrequired

pattern ^(br_)([cC][^\s-]{8,}|[a-z0-9]+)$

createdAtstring · date-timerequired

idstringrequired

pattern ^(bkt_)([cC][^\s-]{8,}|[a-z0-9]+)$

logicalIdnull | stringrequired

namestringrequired

projectobjectrequired

Show child attributes

idstringrequired

pattern ^(proj_)([cC][^\s-]{8,}|[a-z0-9]+)$

namestringrequired

urlstring · urirequired

providerNamestringrequired

statusstringrequired

typestringrequired

const "bucket"

urlstring · urirequired

paginationobjectrequired

Show child attributes

hasMorebooleanrequired

Whether there are more items to paginate

nextCursornull | stringrequired

Next cursor to continue pagination

Example response

{
  "data": [
    {
      "branchId": "string",
      "createdAt": "2026-06-09T00:00:00Z",
      "id": "string",
      "logicalId": "string",
      "name": "string",
      "project": {
        "id": "string",
        "name": "string",
        "url": "https://example.com"
      },
      "providerName": "string",
      "status": "string",
      "type": "bucket",
      "url": "https://example.com"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Examples

cursorquery parameter

limitquery parameter

projectIdquery parameter

logicalIdquery parameter

branchIdquery parameter

branchGitNamequery parameter

curl -X GET 'https://api.prisma.io/v1/buckets?branchGitName=string&branchId=unassigned&cursor=string&limit=100&logicalId=string&projectId=string'

const response = await fetch('https://api.prisma.io/v1/buckets?branchGitName=string&branchId=unassigned&cursor=string&limit=100&logicalId=string&projectId=string', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/buckets?branchGitName=string&branchId=unassigned&cursor=string&limit=100&logicalId=string&projectId=string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.prisma.io/v1/buckets?branchGitName=string&branchId=unassigned&cursor=string&limit=100&logicalId=string&projectId=string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.prisma.io/v1/buckets?branchGitName=string&branchId=unassigned&cursor=string&limit=100&logicalId=string&projectId=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://api.prisma.io/v1/buckets?branchGitName=string&branchId=unassigned&cursor=string&limit=100&logicalId=string&projectId=string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/buckets?branchGitName=string&branchId=unassigned&cursor=string&limit=100&logicalId=string&projectId=string"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/buckets?branchGitName=string&branchId=unassigned&cursor=string&limit=100&logicalId=string&projectId=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://api.prisma.io/v1/buckets?branchGitName=string&branchId=unassigned&cursor=string&limit=100&logicalId=string&projectId=string");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "branchId": "string",
      "createdAt": "2026-06-09T00:00:00Z",
      "id": "string",
      "logicalId": "string",
      "name": "string",
      "project": {
        "id": "string",
        "name": "string",
        "url": "https://example.com"
      },
      "providerName": "string",
      "status": "string",
      "type": "bucket",
      "url": "https://example.com"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Search documentation

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets

Parameters

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets