Skip to main content
GET
Get branch

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.

Response

Branch details.

id
string<uuid>
required
name
string
required
project_id
string<uuid>
required
base_branch_id
string<uuid> | null
created_at
string | null

Persisted branch creation time.

Example:

"2026-09-14T10:00:00.000Z"

created_by
string<uuid> | null
merged_at
string | null

Persisted merge time; null before a merge.

merged_by
string<uuid> | null
status
enum<string>

Stored lifecycle state; closed is distinct from merged.

Available options:
active,
merged,
closed
Example:

"active"

updated_at
string | null
version
integer

Persisted optimistic-concurrency version for expected_version on merge.

Required range: x >= 0
Example:

3

description
string | null
auto_delete_on_merge
boolean