Skip to content

List project branches

BranchListPage projects().branches().list(, )

GET/v0/projects/{project}/branches

Retrieve a project branch by name.

ParametersExpand Collapse

BranchListParams params

Optional<String> project

Optional<String> cursor

Pagination cursor from a previous response

Optional<Double> limit

Maximum number of items to return, defaults to 10 (maximum: 100).

exclusiveMinimum0

maximum100

ReturnsExpand Collapse

class BranchListResponse:

A project branch names a line of development for a project. Like a Git branch, it points to a Git commit with a set of config files. In addition, a project branch also points to a set of custom code changes, corresponding to Git branches in the staging repos.

String branch

Branch name

ConfigCommit configCommit

A Git commit that points to the latest set of config files on a given branch.

Repo repo

String branch

String host

String name

String owner

String sha

Optional<Stats> stats

long additions

long deletions

long total

Optional<String> treeOid

String latestBuildId

Object object_

String org

String project

Project name

List project branches

package com.stainless.api.example;

import com.stainless.api.client.StainlessClient;
import com.stainless.api.client.okhttp.StainlessOkHttpClient;
import com.stainless.api.models.projects.branches.BranchListPage;
import com.stainless.api.models.projects.branches.BranchListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StainlessClient client = StainlessOkHttpClient.builder()
            .fromEnv()
            .project("example-project")
            .build();

        BranchListPage page = client.projects().branches().list();
    }
}

{
  "data": [
    {
      "branch": "branch",
      "config_commit": {
        "repo": {
          "branch": "branch",
          "host": "host",
          "name": "name",
          "owner": "owner"
        },
        "sha": "sha",
        "stats": {
          "additions": 0,
          "deletions": 0,
          "total": 0
        },
        "tree_oid": "tree_oid"
      },
      "latest_build_id": "latest_build_id",
      "object": "project_branch",
      "org": "org",
      "project": "project"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

Returns Examples

{
  "data": [
    {
      "branch": "branch",
      "config_commit": {
        "repo": {
          "branch": "branch",
          "host": "host",
          "name": "name",
          "owner": "owner"
        },
        "sha": "sha",
        "stats": {
          "additions": 0,
          "deletions": 0,
          "total": 0
        },
        "tree_oid": "tree_oid"
      },
      "latest_build_id": "latest_build_id",
      "object": "project_branch",
      "org": "org",
      "project": "project"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}