Skip to content

List project branches

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

GET/v0/projects/{project}/branches

Retrieve a project branch by name.

ParametersExpand Collapse

params: BranchListParams

project: Optional<String>

cursor: Optional<String>

Pagination cursor from a previous response

limit: Optional<Double>

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.

branch: String

Branch name

configCommit: ConfigCommit

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

repo: Repo

branch: String

host: String

name: String

owner: String

sha: String

stats: Optional<Stats>

additions: Long

deletions: Long

total: Long

treeOid: Optional<String>

latestBuildId: String

object_: Object

org: String

project: String

Project name

List project branches

package com.configure_me_stainless_v0.api.example

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

fun main() {
    val client: StainlessClient = StainlessOkHttpClient.builder()
        .fromEnv()
        .project("example-project")
        .build()

    val page: BranchListPage = 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"
}