Skip to main content
GET
/
api
/
projects
/
{projectId}
/
branches
List branches
curl --request GET \
  --url https://api.example.com/api/projects/{projectId}/branches \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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",
      "createdBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "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"
        }
      ]
    }
  ],
  "pagination": {
    "current": 123,
    "from": 123,
    "to": 123,
    "total": 123,
    "pageSize": 123
  }
}

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

Query Parameters

​
page
number
default:1

Current page

​
perPage
number
default:10

Number of items per page

​
search
string

Search term to filter branches by name

Response

200 - application/json

Paginated list of branches

Paginated list of branches

​
data
object[]
required

List of branches

​
pagination
object
required

Pagination information