Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Refs/ Obtaining the Branch List
Updated on 2026-05-12 GMT+08:00
View PDF
Share

Obtaining the Branch List

Function

This API is used to obtain the branch list.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo:repository:getRepository

Read

-

-

-

-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/repository/branches

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can call the API used to query all repositories of the user to query the project list to obtain the repository ID.

Constraints

N/A

Default Value

N/A

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

branch_type

No

String

Definition

Branch type. By default, all branches are returned. not_protect: unprotected branches are returned.

Constraints

N/A.

Range

N/A.

Enumeration values:

  • not_protect

creator

No

String

Definition

Creator, which can be a user ID or IAM ID.

Range

1–100,000 characters.

sort

No

String

Definition

Sorting method.

Constraints

  • name: branch name in descending order.

  • updated_desc: update time in descending order.

  • updated_asc: update time in ascending order.

Default value:

updated_desc

Enumeration values:

  • name

  • updated_desc

  • updated_asc

query_view

No

String

Definition

Branch type.

Constraints

  • my_branches: personal branch.

  • active: active branch.

  • stale: outdated branch.

  • all_branches: all branches.

Default value:

all_branches

Enumeration values:

  • my_branches

  • active

  • stale

  • all_branches

view

No

String

Definition

Result set attribute. Different results are returned based on the given parameters.

Constraints

  • all: returns all branch information.

  • basic: returns basic branch information.

  • simple: returns simple branch information.

Enumeration values:

  • simple

  • basic

  • all

offset

No

Integer

Definition

Offset, which starts from 0.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Definition

Number of returned records.

Value range:

1~100

Default value:

20

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

A string that can contain 1 to 100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Total

String

Definition

Total number of branches.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of BranchSimpleDto objects

Branch list
Table 6 BranchSimpleDto

Parameter

Type

Description

name

String

Branch name

Value range:

1~100000

default

Boolean

Default branch or not

can_delete

Boolean

Whether user's branch is the default branch

can_read

Boolean

Default branch or not

can_download

Boolean

Default branch or not

can_push

Boolean

Default branch or not

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/repositories/2112015538/repository/branches

Example Responses

Status code: 200

Branch list

[ {
  "name" : "master",
  "default" : true,
  "can_delete" : null,
  "can_read" : null,
  "can_download" : null,
  "can_push" : null
} ]

Status code: 401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "User authentication info not found."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.00401008",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status code: 404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "The repository does not exist. Check and try again."
}

Status Codes

Status Code

Description

200

Branch list

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: Refs