Skip to main content
GET
/
projects
/
{project_reference}
/
branches
/
{branchId}
/
merge-preview
Preview Branch Merge
curl --request GET \
  --url https://api.veryfront.com/projects/{project_reference}/branches/{branchId}/merge-preview \
  --header 'Authorization: Bearer <token>'
{
  "source_branch": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "base_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "<string>",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "merged_at": "<string>",
    "merged_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target_branch_name": "<string>",
  "diffs": [
    {
      "file_id": "<string>",
      "file_path": "<string>",
      "file_type": "<string>",
      "has_conflicts": true,
      "conflict_count": 123,
      "is_new": true,
      "is_deleted": true,
      "is_modified": true,
      "base_changed": true,
      "branch_changed": true,
      "conflict_regions": [
        "<unknown>"
      ],
      "base_content": "<string>",
      "target_content": "<string>",
      "source_content": "<string>",
      "original_content": "<string>",
      "modified_content": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

​
project_reference
string
required

Project ID or slug

​
branchId
string<uuid>
required

Branch ID (UUID)

Query Parameters

​
target_branch_id
string<uuid>

Response

Merge preview

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