Get a reference

GET

/repos/{owner}/{repo}/git/ref/{ref}

Returns a single reference from your Git database. 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 match an existing ref, a 404 is returned.

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".

リクエストパラメータ

パスパラメータ

レスポンス

🟢200OK

application/json

Response

ボディapplication/json

🟠404Record Not Found

🟠409409

リクエストExample

Shell

JavaScript

Java

Swift

curl --location 'https://service1.exmaple.com/repos///git/ref/heads/feature-a'

レスポンスExample

200 - default

{
    "ref": "refs/heads/featureA",
    "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==",
    "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA",
    "object": {
        "type": "commit",
        "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
    }
}

更新日時 2025-06-12 06:47:19

List matching references

Create a reference