---
title: "Branch"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.gitpando.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Pando API

## Fields

- `Branch.name` (string, required)
- `Branch.head` (string, required)
- `Branch.checks` (object, required) — GitHub's combined status, plus the required contexts and which are missing.
  - `Branch.checks.sha` (string | null, required)
  - `Branch.checks.state` (string, required) — `success` when the merge gate passes; `missing` when a required context has not reported; `unknown` while the required checks are (an unforced merge is refused).
    - one of `"success"`, `"pending"`, `"failure"`, `"error"`, `"missing"`, `"unknown"`
  - `Branch.checks.required` (array | null, required) — Null while unknown.
  - `Branch.checks.checks_unknown` (string | null, required) — Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise.
  - `Branch.checks.statuses` (array<object>, required) — The latest status per context.
    - `Branch.checks.statuses.sha` (string, required)
    - `Branch.checks.statuses.context` (string, required)
    - `Branch.checks.statuses.state` (string, required)
      - one of `"pending"`, `"success"`, `"failure"`, `"error"`
    - `Branch.checks.statuses.created_at` (string, required)
      - format `date-time`
    - `Branch.checks.statuses.target_url` (string | null, optional)
    - `Branch.checks.statuses.description` (string | null, optional)
    - `Branch.checks.statuses.creator` (string, optional) — The member who posted it (a login); `app:<slug>` for a status posted with a status token or by a CI integration; `hook:<hook id>` for a status token from a web hook with no app.
    - `Branch.checks.statuses.app` (string | null, optional) — The CI service that reported it (`buildkite`, `github-actions`, ...), stamped by Pando from a status token or a CI integration, never from the body or `target_url`. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows.
  - `Branch.checks.missing` (array<string>, optional)
- `Branch.state` (string, required) — `merged` when the branch's current head was landed by a Pando merge.
  - one of `"open"`, `"merged"`
- `Branch.base` (string | null, optional) — The merge base with the default branch; null when there is none.
- `Branch.author` (string | null, optional) — The user whose first push (or createBranch) made the branch.
- `Branch.title` (string | null, optional)
- `Branch.description` (string | null, optional)
- `Branch.ahead` (integer | null, optional) — Commits on the branch that are not on the default branch.
- `Branch.behind` (integer | null, optional) — Commits on the default branch that are not on the branch.
- `Branch.mergeable` (string, optional) — From the merge engine's dry run. `up_to_date`: the branch adds nothing. `pending`: not yet computed for the current main and head (see `last_mergeable`).
  - one of `"clean"`, `"conflicts"`, `"up_to_date"`, `"unknown"`, `"pending"`
- `Branch.stale` (boolean, optional) — True while ahead, behind, base and mergeable are not yet for the current main and head.
- `Branch.last_mergeable` (string | null, optional) — When stale: the last known mergeable answer.
- `Branch.conflict_paths` (array | null, optional) — The paths changed differently on both sides, from the same dry run as `mergeable` (or `last_mergeable` while stale), so a branch page shows them before Merge is pressed. Null unless that answer is `conflicts`. No cap: the same list a refused merge's 409 carries in `paths`.
- `Branch.facts_at` (string | null, optional) — When the facts were computed.
  - format `date-time`
- `Branch.merge_commit` (string | null, optional)
- `Branch.merged_by` (string | null, optional) — The user who merged (state merged only).
- `Branch.merged_at` (string | null, optional)
  - format `date-time`
- `Branch.merged_machine` (string | null, optional) — The name of the credential used to merge: the machine or sandbox.
- `Branch.merged_agent` (string | null, optional) — The agent that merged, from X-Pando-Agent, if one said so.
- `Branch.pushed_machine` (string | null, optional) — The name of the credential that last pushed the branch: the machine or sandbox.
- `Branch.forced` (boolean | null, optional) — True when the merge went past red or missing checks with force=1.
- `Branch.created_at` (string | null, optional)
  - format `date-time`
- `Branch.updated_at` (string | null, optional)
  - format `date-time`


Source: https://docs.gitpando.com/api/schemas/Branch/index.md