Skip to main content
GET
Get branch merge preview

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.

Query Parameters

target_branch_id
string<uuid> | null

Target branch ID; omit for main.

Response

Merge preview.

source_branch
object
required

Branch to merge.

target_branch_id
string<uuid> | null
required

Branch that receives the merge, or null for main.

target_branch_name
string
required

Name of the branch that receives the merge.

can_merge
boolean
required

True only when blocked_reason is null, merge policies pass and no file has conflicts. Advisory: the merge checks these conditions again.

blocked_reason
string | null
required

Precondition that blocks the merge, such as a merged or closed branch, or a target that is the source branch or is closed; null when none does. A target that is missing or in another project is a not found error.

has_conflicts
boolean
required

Whether at least one file has conflicts.

diffs
object[]
required

File-by-file changes the merge applies.