List Branches
github.list_branches
ActionBusiness appsconnection required
Calls the GitHub API GET /repos/{owner}/{repo}/branches.
List a repository's branches.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- GitHub
- Secret shape
- the GitHub personal access token
- Resolved by
- config.connection_id, else node.connection_id, else the tenant's sole GitHub connection
Configuration
4 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
owner Repository owner — the user or organisation login. Supports {{ }}. | string | Yes | — | — | octocat |
repo Repository name, without the owner prefix. Supports {{ }}. | string | Yes | — | — | hello-world |
protected Only return protected branches. | boolean | No | — | — | — |
max_items Stop after this many rows; further pages are followed via the Link header. | number | No | 100 | 1–1000 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"max_items": 100,
"owner": "octocat",
"repo": "hello-world"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
branches The branches this step read. | array | — |
branches[].name Branch name. | string | — |
branches[].commit_sha SHA the branch points at. | string | — |
branches[].protected True when branch protection applies. | boolean | — |
count How many rows this step returned. | number | — |
{
"branches": [
{
"commit_sha": "",
"name": "",
"protected": false
}
],
"count": 0
}Solutions with GitHub
See List Branches run in a workflow.
In a technical demo we add the GitHub connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.