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

# Check branch merge eligibility

> Check policies, approvals and status checks to say whether a branch can merge now.

`branchMergeEligibility(branchId: ID!): BranchMergeEligibility!`

Requires project.read.

## Arguments

| Argument | Type | Required | Description |
| - | - | - | - |
| `branchId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | Branch to check. A missing branch and one the caller cannot read are both not found. |

## Response

Returns [`BranchMergeEligibility!`](https://veryfront.com/docs/cloud/graphql/types/branchmergeeligibility). Open the type for its fields and nested types.

| Field | Type | Description |
| - | - | - |
| `canMerge` | [`Boolean!`](https://veryfront.com/docs/cloud/graphql/types/boolean) | |
| `applicablePolicies` | [`[BranchPolicy!]!`](https://veryfront.com/docs/cloud/graphql/types/branchpolicy) | Enabled policies that match the branch. |
| `approvals` | [`[BranchApproval!]!`](https://veryfront.com/docs/cloud/graphql/types/branchapproval) | Approvals that still count. |
| `statusChecks` | [`[BranchStatusCheck!]!`](https://veryfront.com/docs/cloud/graphql/types/branchstatuscheck) | |
| `blockers` | [`[BranchMergeBlocker!]!`](https://veryfront.com/docs/cloud/graphql/types/branchmergeblocker) | Reasons the branch cannot merge; empty when it can. |

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
query BranchMergeEligibility($branchId: ID!) {
  branchMergeEligibility(branchId: $branchId) {
    canMerge
  }
}
```

```json title="variables.json" theme={null}
{
  "branchId": "00000000-0000-4000-8000-000000000001"
}
```

<details>
  <summary>Try this query</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Query

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.