repos.branches.list

List branches in the repository with cursor pagination. Use this to build branch selectors, review tools, or sync jobs without shelling out to Git. A new empty repository has no branch until its first commit, so its list is empty.

Scope: git:read on the repository.

GET /api/repos/{repo_name}/branches

TypeScript

TypeScript

import { Pierre } from '@pierre/sdk';

// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
const pierre = new Pierre();

for await (const branch of pierre.repos.branches.list({
  repo_name: 'my-demo-repository',
  limit: 20,
})) {
  console.log(branch);
}

200

{
  "branches": [
    {
      "created_at": "2024-01-15T10:30:00Z",
      "cursor": "b_123abc",
      "head_sha": "a1b2c3d4e5f6",
      "name": "main"
    }
  ],
  "has_more": true,
  "next_cursor": "MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY"
}

Authorizations

Authorization · string · header · required

JWT bearer token signed with your organization's registered signing key. There is no OAuth authorization server; you mint tokens yourself and the token's scopes claim carries the granted permission scopes. Public scopes: git:read (read repository contents), git:write (write branches, commits, tags, and notes), repo:write (create and manage repositories), org:read (list an organization's repositories). Each operation's security requirement names the scopes it requires. See https://code.storage/docs/getting-started/authentication for how to mint tokens.

Path Parameters

repo_name · string · required

The repository name, for example acme/web.

Query Parameters

cursor · string

Pagination cursor returned by a previous list_branches response.

limit · integer · default: 20

Maximum number of branches to return. Defaults to 20.

ephemeral · boolean

When true, list branches under the ephemeral namespace instead of regular branches.

Response

200

application/json

Repository branches in creation order.

Paginated list of branches for the repository.

branches · object[] · required

List of branch objects.

Show child attributes

has_more · boolean · required

Whether another page is available.

Example:

true

next_cursor · string

Opaque cursor for the next page. Pass it as cursor to read the next page. Absent when there are no more results.

Example:

"MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY"