Get Single Branch

GET 
/api/v5/repos/:owner/:repo/branches/:branch

Request

Path Parameters

owner stringrequired

Repository space address (organization or individual's address path)

repo stringrequired

Repository path (path)

branch stringrequired

Branch name

Query Parameters

access_token string

User authorization code

Responses

200

Successful Response

Response Headers

application/json

Schema

Schema

namestringrequired
descriptionstringrequired
commit objectrequired
idstringrequired
messagestringrequired
parent_idsstring[]required
authored_datestringrequired
author_namestringrequired
author_emailstringrequired
author_user_namestringrequired
committed_datestringrequired
committer_namestringrequired
committer_emailstringrequired
committer_user_namestringrequired
short_idstringrequired
created_atstringrequired
titlestringrequired
author_avatar_urlstringrequired
committer_avatar_urlstringrequired
mergedbooleanrequired
protectedbooleanrequired
developers_can_pushbooleanrequired
developers_can_mergebooleanrequired
can_pushbooleanrequired
defaultbooleanrequired
created_atstringrequired
creation time
creator objectrequired
Creator
avatar_urlstringrequired
idstringrequired
loginstringrequired
namestringrequired

Example (auto)

{
  "name": "string",
  "description": "string",
  "commit": {
    "id": "string",
    "message": "string",
    "parent_ids": [
      "string"
    ],
    "authored_date": "string",
    "author_name": "string",
    "author_email": "string",
    "author_user_name": "string",
    "committed_date": "string",
    "committer_name": "string",
    "committer_email": "string",
    "committer_user_name": "string",
    "short_id": "string",
    "created_at": "string",
    "title": "string",
    "author_avatar_url": "string",
    "committer_avatar_url": "string"
  },
  "merged": true,
  "protected": true,
  "developers_can_push": true,
  "developers_can_merge": true,
  "can_push": true,
  "default": true,
  "created_at": "string",
  "creator": {
    "avatar_url": "string",
    "id": "string",
    "login": "string",
    "name": "string"
  }
}

Example

{
  "name": "dev",
  "commit": {
    "id": "b6d44deb0ca73d7a50916d0fea02c72edd6c924e",
    "message": "dev add new file\n\nCreated-by: csdntest13\nAuthor-id: 494\nMR-id: 68629\nCommit-by: csdntest13\nMerged-by: csdntest13\nE2E-issues: \nDescription: commit message\n\nSee merge request: One/One!56",
    "parent_ids": [
      "13956ffeb5e5e1ce60c2ed91d3e579fc50b1f167",
      "3e42dcb9c09b39972c65536dad71651322470f28"
    ],
    "authored_date": "2024-04-15T14:38:50.000Z",
    "author_name": "csdntest13",
    "author_iam_id": null,
    "author_email": "csdntest13@noreply.gitcode.com",
    "author_user_name": null,
    "committed_date": "2024-04-15T14:38:50.000Z",
    "committer_name": "csdntest13",
    "committer_email": "csdntest13@noreply.gitcode.com",
    "committer_user_name": null,
    "open_gpg_verified": null,
    "verification_status": null,
    "gpg_primary_key_id": null,
    "short_id": "b6d44deb",
    "created_at": "2024-04-15T14:38:50.000Z",
    "title": "merge refs/merge-requests/56/head into dev",
    "author_avatar_url": "https://gitcode-img.obs.cn-south-1.myhuaweicloud.com:443/ec/ba/4e7c4661b6154a7dd088d9fe64b4893383a2e318bf362350ce18d44df6ac7e37.png?time=1711533165876",
    "committer_avatar_url": "https://gitcode-img.obs.cn-south-1.myhuaweicloud.com:443/ec/ba/4e7c4661b6154a7dd088d9fe64b4893383a2e318bf362350ce18d44df6ac7e37.png?time=1711533165876",
    "relate_url": null
  },
  "merged": false,
  "protected": false,
  "developers_can_push": false,
  "developers_can_merge": false,
  "can_push": true,
  "default": false
}