List branches in a project

GET/v1/projects/{projectId}/branchesList branches in a project

⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Returns the live Branches of a Project. Supports two mutually exclusive filters: ?gitName= (exact match — at most one row), ?gitNameContains= (case-sensitive substring). Soft-deleted Branches are not returned. Ordered by createdAt ascending.

Parameters

projectIdstringpathrequired

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

cursornull | stringquery

Cursor for pagination

limitnumberquery

Limit for pagination

default 100

gitNamestringquery

minLength 1

gitNameContainsstringquery

minLength 1

Responses

object

dataarray of objectrequired

Show child attributes

Show array items

createdAtstring · date-timerequired

gitNamestringrequired

idstringrequired

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

isDefaultbooleanrequired

projectobjectrequired

Thin reference to the parent Project. Member resources are intentionally NOT inlined — list /v1/databases?branchId=<br_xxx> or /v1/apps?branchId=<br_xxx> instead (see API design principles "Flat and Hierarchical Coexistence").

Show child attributes

idstringrequired

namestringrequired

urlstring · urirequired

rolestringrequired

one of "production", "preview"

typestringrequired

const "branch"

updatedAtstring · date-timerequired

urlstring · urirequired

paginationobjectrequired

Show child attributes

hasMorebooleanrequired

nextCursornull | stringrequired

Example response

{
  "data": [
    {
      "createdAt": "2026-06-09T00:00:00Z",
      "gitName": "string",
      "id": "string",
      "isDefault": true,
      "project": {
        "id": "string",
        "name": "string",
        "url": "https://example.com"
      },
      "role": "preview",
      "type": "branch",
      "updatedAt": "2026-06-09T00:00:00Z",
      "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"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

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

Examples

projectIdrequiredpath parameter

cursorquery parameter

limitquery parameter

gitNamequery parameter

gitNameContainsquery parameter

curl -X GET 'https://api.prisma.io/v1/projects/string/branches?cursor=string&gitName=string&gitNameContains=string&limit=100'

const response = await fetch('https://api.prisma.io/v1/projects/string/branches?cursor=string&gitName=string&gitNameContains=string&limit=100', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/projects/string/branches?cursor=string&gitName=string&gitNameContains=string&limit=100', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.prisma.io/v1/projects/string/branches?cursor=string&gitName=string&gitNameContains=string&limit=100")
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/projects/string/branches?cursor=string&gitName=string&gitNameContains=string&limit=100", 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/projects/string/branches?cursor=string&gitName=string&gitNameContains=string&limit=100");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/projects/string/branches?cursor=string&gitName=string&gitNameContains=string&limit=100"))
    .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/projects/string/branches?cursor=string&gitName=string&gitNameContains=string&limit=100")
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/projects/string/branches?cursor=string&gitName=string&gitNameContains=string&limit=100");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "createdAt": "2026-06-09T00:00:00Z",
      "gitName": "string",
      "id": "string",
      "isDefault": true,
      "project": {
        "id": "string",
        "name": "string",
        "url": "https://example.com"
      },
      "role": "preview",
      "type": "branch",
      "updatedAt": "2026-06-09T00:00:00Z",
      "url": "https://example.com"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "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