Get All Project Branches

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

Request

Path Parameters

owner stringrequired

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

repo stringrequired

Repository path (path)

Query Parameters

access_token string

User authorization code

sort string

Sort field by name/updated

direction string

sort direction asc/desc

page integer

The current page number

per_page integer

The number of items per page, with a maximum of 100. The default is 20.

Responses

200

Successful Response

Response Headers

application/json

Schema

Schema

Array [
namestringrequired
descriptionstringrequired
commit objectrequired
commit objectrequired
author objectrequired
namestringrequired
datestringrequired
emailstringrequired
committer objectrequired
namestringrequired
datestringrequired
emailstringrequired
messagestringrequired
shastringrequired
urlstringrequired
default_branchbooleanrequired
Is the default branch
created_atstringrequired
creation time
creator objectrequired
Creator
avatar_urlstringrequired
idstringrequired
loginstringrequired
namestringrequired
protectedbooleanrequired
]

Example (auto)

[
  {
    "name": "string",
    "description": "string",
    "commit": {
      "commit": {
        "author": {
          "name": "string",
          "date": "string",
          "email": "string"
        },
        "committer": {
          "name": "string",
          "date": "string",
          "email": "string"
        },
        "message": "string"
      },
      "sha": "string",
      "url": "string"
    },
    "default_branch": true,
    "created_at": "string",
    "creator": {
      "avatar_url": "string",
      "id": "string",
      "login": "string",
      "name": "string"
    },
    "protected": true
  }
]

Example

{
  "name": "main",
  "commit": {
    "commit": {
      "author": {
        "name": "Lzm_0916",
        "date": "2024-04-16T08:41:20.000Z",
        "email": "Lzm_0916@noreply.gitcode.com"
      },
      "committer": {
        "name": "Lzm_0916",
        "date": "2024-04-16T08:41:20.000Z",
        "email": "Lzm_0916@noreply.gitcode.com"
      },
      "message": "submit test class"
    },
    "sha": "1d45587145552af003cd32cc6fde9ac9d9e5fd42",
    "url": "https://test.gitcode.net/api/v5/repos/Lzm_0916/test/commits/1d45587145552af003cd32cc6fde9ac9d9e5fd42"
  },
  "protected": true
}