Skip to main content
Read a note attached to a specific commit. 
GET /api/v1/repos/notes?sha=COMMIT_SHA
Authorization: Bearer YOUR_JWT_TOKEN

​
Parameters

​
sha
string
required
The commit SHA to read the note from

​
JWT Requirements

  • The JWT must include the repository in the repo claim
  • Requires git:read scope

​
Response

{
  "sha": "abc123def456789...",
  "note": "Build passed ✓ - deployed to staging",
  "ref_sha": "def789abc123456..."
}

​
Response Fields

​
sha
string
The commit SHA
​
note
string
The note content
​
ref_sha
string
Current SHA of refs/notes/commits

​
Notes

  • Git notes are stored in refs/notes/commits
  • Notes allow attaching metadata to commits without modifying the commit itself
  • Common use cases include build status, review comments, and deployment annotations

​
Error Responses

​
404 Not Found
string
Note doesn’t exist for the specified commit
​
401 Unauthorized
string
Invalid JWT or missing git:read scope
​
400 Bad Request
string
Missing sha parameter