Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying the Task Branch List
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Task Branch List

Function

This API is used to query the branch list of a task by task ID and branch name with pagination.

Calling Method

For details, see Calling APIs.

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

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v4/tasks/{task_id}/branches

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

1 to 128 characters.

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

is_uncreated_only

No

String

Definition:

Whether to query only branches without branch tasks.

Constraints:

N/A

Value range:

  • true: Only branches without branch tasks are queried.

  • false: All branches are queried.

Default value:

false

page

No

Integer

Definition:

Page number.

Constraints:

≥ 1.

Value range:

1–2,147,483,647

Default value:

N/A

page_size

No

Integer

Definition:

Page size.

Constraints:

The value ranges from 1 to 200.

Value range:

1–200

Default value:

N/A

search

No

String

Definition:

Name of the branch to be searched.

Constraints:

N/A

Value range:

Max. 128 characters.

Default value:

N/A

repo_type

No

String

Definition:

Code repository type.

Constraints:

N/A

Value range:

GitCode, GitLab, GitPub, Gitee, CodeArts.

Default value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition :

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints:

N/A

Value range:

1–100,000 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

branch_list

Array of strings

Definition:

Branch name list.

Range:

Max. 200.

total

Integer

Definition:

Total number of branches.

Value range:

≥0

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

Query the branch list of task ID 897acf5exxx48a5013cd, where branch names contain 'test01' and no branch task has been created. Records on page one are returned, with 20 items per page.

GET https://{endpoint}/v4/tasks/897acf5exxx48a5013cd/branches?is_uncreated_only=true&search=test01&page=1&page_size=20

Example Responses

Status code: 200

Request succeeded!

{
  "data" : [ "dev", "master" ],
  "total" : 2
}

Status code: 400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Task Management