Skip to main content
GET
/
projects
/
{project_reference}
/
branches
/
{branchId}
/
eligibility
Check Branch Eligibility
curl --request GET \
  --url https://api.veryfront.com/projects/{project_reference}/branches/{branchId}/eligibility \
  --header 'Authorization: Bearer <token>'
{
  "can_merge": true,
  "approvals": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "approved_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "approved_at": "<string>",
      "comment": "<string>",
      "dismissed_at": "<string>",
      "dismissed_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dismissed_reason": "<string>"
    }
  ],
  "status_checks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "check_name": "<string>",
      "status": "pending",
      "description": "<string>",
      "external_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "blockers": [
    {
      "type": "approvalRequired",
      "message": "<string>",
      "details": {}
    }
  ]
}

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)

Response

Merge eligibility result

can_merge
boolean
required
approvals
object[]
required
status_checks
object[]
required
blockers
object[]
required