Skip to main content
GET
Check branch merge eligibility

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

branch_id
string<uuid>
required

Branch UUID belonging to the selected project. Missing or foreign branches return 404.

Response

Merge eligibility result. A branch that cannot merge is a result with blockers, not an error.

can_merge
boolean
required

Whether policies, approvals and status checks allow the merge now.

applicable_policies
object[]
required

Enabled policies that match the branch.

approvals
object[]
required

Approvals that still count.

status_checks
object[]
required

Status checks reported for the branch.

blockers
object[]
required

Reasons the branch cannot merge; empty when it can.