repos.branches.get

Get one branch by its exact short name. The response omits list pagination fields. A new empty repository has no branch until its first commit, so the request returns 404.

Scope: git:read on the repository.

GET /api/repos/{repo_name}/branch

TypeScript

TypeScript

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

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

const branch = await pierre.repos.branches.get({
  repo_name: 'my-demo-repository',
  name: 'main',
});
console.log(branch);

200

{
  "branch": {
    "created_at": "2024-01-15T10:30:00Z",
    "head_sha": "a1b2c3d4e5f6",
    "name": "main"
  }
}

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

name · string · required

Exact short branch name.

ephemeral · boolean

When true, get the branch from the ephemeral namespace.

Response

200

application/json

The branch with the requested name.

One branch that matches an exact short name.

branch · object · required

The branch that has the requested name.

Show child attributes