GitHub: List branches

← Repos operations · Get started

Operation github.repos_list_branches

Provider route: GET /repos/{owner}/{repo}/branches. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["repos"]["reposListBranches"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.repos.reposListBranches(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.repos.repos_list_branches(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.protected	boolean	Optional
query.per_page	integer	Optional	Default: 30
query.page	integer	Optional	Default: 1

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	array	Root
$[]	Model	Each item	Expand List branches — response body — item

Referenced models: List branches — response body — item

Schemas

7 more schemas are linked from the tables above, on the schema pages.

List branches — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Short Branch
commit	object	Required within parent
commit.sha	string	Required within parent
commit.url	string	Required within parent	Format: uri
name	string	Required within parent
protected	boolean	Required within parent
protection	Model	Optional	Expand Get branch protection — response body
protection_url	string	Optional	Format: uri

Referenced models: Get branch protection — response body

Get branch protection — response body

Field	Type	Presence	Description and constraints
$	object	Root	Branch Protection
allow_deletions	object	Optional
allow_deletions.enabled	boolean	Optional
allow_force_pushes	object	Optional
allow_force_pushes.enabled	boolean	Optional
allow_fork_syncing	object	Optional	Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.
allow_fork_syncing.enabled	boolean	Optional	Default: false
block_creations	object	Optional
block_creations.enabled	boolean	Optional
enabled	boolean	Optional
enforce_admins	Model	Optional	Expand Get admin branch protection — response body
lock_branch	object	Optional	Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
lock_branch.enabled	boolean	Optional	Default: false
name	string	Optional
protection_url	string	Optional
required_conversation_resolution	object	Optional
required_conversation_resolution.enabled	boolean	Optional
required_linear_history	object	Optional
required_linear_history.enabled	boolean	Optional
required_pull_request_reviews	Model	Optional	Expand Get pull request review protection — response body
required_signatures	object	Optional
required_signatures.enabled	boolean	Required within parent
required_signatures.url	string	Required within parent	Format: uri
required_status_checks	Model	Optional	Expand Get branch protection — response body — required status checks
restrictions	Model	Optional	Expand Get access restrictions — response body
url	string	Optional

Referenced models: Get access restrictions — response body, Get admin branch protection — response body, Get pull request review protection — response body, Get branch protection — response body — required status checks

Get access restrictions — response body

Field	Type	Presence	Description and constraints
$	object	Root	Branch Restriction Policy
apps	array	Required within parent
apps[]	object	Each item
apps[].client_id	string	Optional
apps[].created_at	string	Optional
apps[].description	string	Optional
apps[].events	array	Optional
apps[].events[]	string	Each item
apps[].external_url	string	Optional
apps[].html_url	string	Optional
apps[].id	JSON	Optional
apps[].id (anyOf 1)	integer	Alternative
apps[].id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
apps[].name	string	Optional
apps[].node_id	string	Optional
apps[].owner	object	Optional
apps[].owner.avatar_url	string	Optional
apps[].owner.description	string	Optional
apps[].owner.events_url	string	Optional
apps[].owner.followers_url	string	Optional
apps[].owner.following_url	string	Optional
apps[].owner.gists_url	string	Optional
apps[].owner.gravatar_id	string	Optional
apps[].owner.hooks_url	string	Optional
apps[].owner.html_url	string	Optional
apps[].owner.id	JSON	Optional
apps[].owner.id (anyOf 1)	integer	Alternative
apps[].owner.id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
apps[].owner.issues_url	string	Optional
apps[].owner.login	string	Optional
apps[].owner.members_url	string	Optional
apps[].owner.node_id	string	Optional
apps[].owner.organizations_url	string	Optional
apps[].owner.public_members_url	string	Optional
apps[].owner.received_events_url	string	Optional
apps[].owner.repos_url	string	Optional
apps[].owner.site_admin	boolean	Optional
apps[].owner.starred_url	string	Optional
apps[].owner.subscriptions_url	string	Optional
apps[].owner.type	string	Optional
apps[].owner.url	string	Optional
apps[].owner.user_view_type	string	Optional
apps[].permissions	object	Optional
apps[].permissions.contents	string	Optional
apps[].permissions.issues	string	Optional
apps[].permissions.metadata	string	Optional
apps[].permissions.single_file	string	Optional
apps[].slug	string	Optional
apps[].updated_at	string	Optional
apps_url	string	Required within parent	Format: uri
teams	array	Required within parent
teams[]	Model	Each item	Expand List teams — response body — item
teams_url	string	Required within parent	Format: uri
url	string	Required within parent	Format: uri
users	array	Required within parent
users[]	object	Each item
users[].avatar_url	string	Optional
users[].events_url	string	Optional
users[].followers_url	string	Optional
users[].following_url	string	Optional
users[].gists_url	string	Optional
users[].gravatar_id	string	Optional
users[].html_url	string	Optional
users[].id	JSON	Optional
users[].id (anyOf 1)	integer	Alternative	Format: int64
users[].id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
users[].login	string	Optional
users[].node_id	string	Optional
users[].organizations_url	string	Optional
users[].received_events_url	string	Optional
users[].repos_url	string	Optional
users[].site_admin	boolean	Optional
users[].starred_url	string	Optional
users[].subscriptions_url	string	Optional
users[].type	string	Optional
users[].url	string	Optional
users[].user_view_type	string	Optional
users_url	string	Required within parent	Format: uri

Referenced models: List teams — response body — item

Get admin branch protection — response body

Field	Type	Presence	Description and constraints
$	object	Root	Protected Branch Admin Enforced
enabled	boolean	Required within parent
url	string	Required within parent	Format: uri

Create a team — response body — parent

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Create a team — response body — parent / type: enterprise, organization
$ (anyOf 2)	null	Alternative

Referenced models: Create a team — response body — parent / type: enterprise, organization

Policy, approvals and errors

SDK function policy ID: github.repos_list_branches. Catalog operation: repos/list-branches. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source