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>

Target branch ID; omit for main. An unknown target returns not found. Merge eligibility and conflicts are checked again when the merge commits.

Response

Merge preview.

source_branch
object
required
target_branch_id
string<uuid> | null
required
target_branch_name
string
required
diffs
object[]
required