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>'
{
  "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>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gorules.io/llms.txt

Use this file to discover all available pages before exploring further.

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
required

Latest commit on the branch

​
totalCommits
number
required

Total number of commits on the branch

​
createdBy
object

User who created the branch