List branches
Lists a repository's branches, the default first, with prefix search.
GET /v1/provider/github/repos/{owner}/{repo}/branches
| Address | https://api.hanzo.ai/v1/provider/github/repos/{owner}/{repo}/branches |
| Method | GET |
| Operation | get_provider_github_repos_by_owner_by_repo_branches |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Lists a repository's branches, the default first, with prefix search. The repository must be one the caller may see — the same set GET /v1/provider/github/repos lists — or it is 404.
Request
5 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
owner | path | string | yes | Owner is the GitHub account that holds the repository. |
repo | path | string | yes | Repo is the repository's name within that account. |
q | query | string | — | Q keeps branches whose name starts with it, matched by GitHub. |
limit | query | integer | — | Limit is the page size: 1 to 100, and 50 when absent or unreadable. |
after | query | string | — | After is the next of the previous page. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | provider.githubBranchesOut | ok |
default | problem-details | refused |
200 body — 6 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
branches | body | provider.githubBranch[] | — | Branches is this page: the default branch first, then the rest by name. |
branches[].commit | body | string | — | Commit is the sha the branch points at. |
branches[].default | body | boolean | — | Default is whether it is the repository's default branch, which always leads the first page when it matches. |
branches[].name | body | string | — | Name is the branch's short name ("main", "feat/login"). |
next | body | string | — | Next is the cursor for the page after this one; empty on the last page. |
total | body | integer (int64) | — | Total is how many branches match q, across every page. |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, ProviderApi } from 'hanzoai';
const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getProviderGithubReposByOwnerByRepoBranches({ owner: 'owner', repo: 'repo' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProviderApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProviderApi(client).get_provider_github_repos_by_owner_by_repo_branches(owner='owner', repo='repo')cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.ProviderAPI.GetProviderGithubReposByOwnerByRepoBranches(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, provider_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = provider_api::get_provider_github_repos_by_owner_by_repo_branches(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProviderApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new ProviderApi(client).getProviderGithubReposByOwnerByRepoBranches();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/provider/github/repos/<owner>/<repo>/branches \
-H "Authorization: Bearer $HANZO_API_KEY"MCP declares no tool for provider — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?