List matching references

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "Checking mergeability of pull requests".

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

[ { "node_id": "string", "object": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "type": "string", "url": "http://example.com" }, "ref": "string", "url": "http://example.com" } ]

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

ref

string

必需

ref parameter

Query 参数

per_page

integer

可选

Results per page (max 100).

page

integer

可选

Page number of the results to fetch.

返回响应

🟢200Response

application/json

Body

array of:

node_id

string

必需

object

必需

sha

string

必需

SHA for the reference

>= 40 字符<= 40 字符

示例值:

7638417db6d59f3c431d3e1f261cc637155684cd

type

string

必需

url

string <uri>

必需

ref

string

必需

url

string <uri>

必需