Skip to main content
GET
/
api
/
projects
/
{projectId}
/
branches
/
{branchId}
Get branch
curl --request GET \
  --url https://api.example.com/api/projects/{projectId}/branches/{branchId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/projects/{projectId}/branches/{branchId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/projects/{projectId}/branches/{branchId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/projects/{projectId}/branches/{branchId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/projects/{projectId}/branches/{branchId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/projects/{projectId}/branches/{branchId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/projects/{projectId}/branches/{branchId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "default": true,
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "baseCommitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "changeRequests": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "type": "<string>",
      "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "latestCommit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "message": "<string>",
    "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "files": [
      "<unknown>"
    ]
  },
  "totalCommits": 123,
  "createdBy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

projectId
string<uuid>
required

Project ID

branchId
required

Branch ID or "main" for the default branch

Response

200 - application/json

Branch details with latest commit and change requests

Branch details with latest commit and change requests

id
string<uuid>
required

Branch ID

name
string
required

Branch name

default
boolean
required

Whether this is the default (main) branch

projectId
string<uuid>
required

Project ID

baseCommitId
string<uuid> | null
required

Base commit ID

createdById
string<uuid> | null
required

ID of user who created the branch

createdAt
string<date-time>
required

Creation timestamp

updatedAt
string<date-time>
required

Last update timestamp

changeRequests
object[]
required

Pending change requests

latestCommit
object | null
required

Latest commit on the branch

totalCommits
number
required

Total number of commits on the branch

createdBy
object | null

User who created the branch