List matching references

GET

/repos/{owner}/{repo}/git/matching-refs/{ref}

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///git/matching-refs/'

Response Example

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

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

ref

string

required

ref parameter

Responses

🟢200Response

application/json

Body

array of:

node_id

string

required

object

required

sha

string

required

SHA for the reference

>= 40 characters<= 40 characters

Example:

7638417db6d59f3c431d3e1f261cc637155684cd

type

string

required

url

string <uri>

required

ref

string

required

url

string <uri>

required

Modified at 2023-08-15 02:59:30

Get a commit

Get a reference