List project branches

BranchListPageResponse Projects.Branches.List(, )

GET/v0/projects/{project}/branches

Retrieve a project branch by name.

ParametersExpand Collapse

BranchListParams parameters

required string project

Path param

string cursor

Query param: Pagination cursor from a previous response

Double limit

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

exclusiveMinimum0

maximum100

ReturnsExpand Collapse

class BranchListPageResponse:

required IReadOnlyList<BranchListResponse> Data

required string Branch

Branch name

required ConfigCommit ConfigCommit

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

required Repo Repo

required string Branch

required string Name

required string Owner

required string Sha

required string LatestBuildID

required Object Object

required string Org

required string Project

Project name

required Boolean HasMore

string NextCursor

List project branches

BranchListParams parameters = new() { Project = "project" };

var page = await client.Projects.Branches.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "data": [
    {
      "branch": "branch",
      "config_commit": {
        "repo": {
          "branch": "branch",
          "name": "name",
          "owner": "owner"
        },
        "sha": "sha"
      },
      "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",
          "name": "name",
          "owner": "owner"
        },
        "sha": "sha"
      },
      "latest_build_id": "latest_build_id",
      "object": "project_branch",
      "org": "org",
      "project": "project"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}