---
title: "Get merge preview"
method: GET
path: "/api/projects/{projectId}/branches/{branchId}/merge-preview"
tags: ["Branches"]
---

# Get merge preview

`GET /api/projects/{projectId}/branches/{branchId}/merge-preview`

Previews the result of merging a branch into main, including any conflicts.

## Path parameters

- `projectId` string, uuid, required
- `branchId` union, required
  - string, uuid
  - 'main'

## Response `200`

Merge preview result

- object — Merge preview result
  - `canMerge` boolean, required — Whether the branch can be merged without conflicts
  - `isUpToDate` boolean, required — Whether the branch is up to date with main
  - `needsRebase` boolean, required — Whether the branch needs to be rebased
  - `changes` object[], required — List of file changes that would result from merge
    - `type` 'added' | 'deleted' | 'modified' | 'renamed', required — Type of change
    - `file` unknown
    - `from` unknown
    - `to` unknown
  - `conflicts` object[], required — List of merge conflicts
    - `reason` 'modify/modify' | 'delete/modify' | 'add/add' | 'directory/file', required — Reason for the conflict
    - `path` string, required — File path where conflict occurred
    - `base` unknown
    - `ours` unknown
    - `theirs` unknown
    - `deleted` 'ours' | 'theirs' — Which side deleted the file
    - `modified` unknown
  - `stats` object, required — Change statistics
    - `filesAdded` number, required — Number of files added
    - `filesDeleted` number, required — Number of files deleted
    - `filesModified` number, required — Number of files modified
    - `filesRenamed` number — Number of files renamed
    - `totalChanges` number, required — Total number of changes
  - `message` string, required — Human-readable merge status message

---

[API](https://skmtc.dev/gorules/apis/gorules-agent-api.md) · [All operations](https://skmtc.dev/gorules/apis/gorules-agent-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gorules/gorules-agent-api/revisions/52c0773fcd80/schema)