Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Obtaining a Repository Branch List

Updated on 2025-01-14 GMT+08:00

View PDF

Obtaining a Repository Branch List

Function

This API is used to obtain a branch list of a repository.

URI

GET /v2/repositories/{repository_id}/branches

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Repository short ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page	No	String	Page number.
per_page	No	String	Number of data records on each page.
match	No	String	Match condition.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained 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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
error	Error object	Response error.
result	BranchResponse object	Response result.
status	String	Response status.

**Table 5** Error
Parameter	Type	Description
code	String	Error code.
message	String	Error message.

**Table 6** BranchResponse
Parameter	Type	Description
branches	Array of BranchesItem objects	Branch information.
total	Double	Total number.

**Table 7** BranchesItem
Parameter	Type	Description
commit	CommitV2 object	Commit message.
diverging_commit_counts	DivergingCommitCounts object	Commit discrepancy.
name	String	Branch name.

**Table 8** CommitV2
Parameter	Type	Description
committed_date	String	Commit time.
committer_name	String	Committer.
id	String	Commit ID.
message	String	Commit message.
short_id	String	Commit short ID.
title	String	Commit title.

**Table 9** DivergingCommitCounts
Parameter	Type	Description
ahead	Double	Ahead commit counts.
behind	Double	Behind commit counts.

Example Requests

GET https://{endpoint}/v2/repositories/{repository_id}/branches

Example Responses

Status code: 200

{
  "result" : {
    "total" : 1,
    "branches" : [ {
      "name" : "master",
      "commit" : {
        "id" : "2912b8f2328e798f7d544272ffaebfccccb598ab",
        "title" : "Initial commit",
        "message" : "Initial commit",
        "committed_date" : "2021-12-06T09:24:50.000+08:00",
        "short_id" : "2912b8f2",
        "committer_name" : "repo"
      },
      "diverging_commit_counts" : {
        "behind" : 0,
        "ahead" : 0
      }
    } ]
  },
  "status" : "success"
}