View as Markdown
GitHub icon

GitHub ACTION

List Branches

List the branches in a repository. Provide the repository as an owner/repo string. Optionally filter to only protected (or only unprotected) branches. If you need to discover repository names first, use List Repositories. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's GitHub account once, then configure and run List Branches from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "github-list-branches",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    github: { authProvisionId: "apn_xxxxxxx" },
    repoFullname: "Repository",
    protected: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Branches inputs
Property Type Description
repoFullname Repository string
The repository in owner/repo format, for example PipedreamHQ/pipedream (not case sensitive). If you pass just a repository name with no owner (e.g. my-repo), the authenticated user is assumed as the owner — convenient for "my repo" requests. Do NOT repeat the repository name as the owner (e.g. my-repo/my-repo); if you don't know the owner, pass only the name or run List Repositories to find it.
Required
protected Protected boolean
Set to true to return only branches protected by branch protections or rulesets, or false for only unprotected branches. Omit to return all branches.
Optional
maxResults Max Results integer
The maximum number of results to return. Defaults to 100.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
github-list-branches
Version
1.0.2
App
GitHub
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes