Get note

GET /api/v1/repos/notes

Read a note attached to a specific commit.

GET /api/v1/repos/notes?sha=COMMIT_SHA
Authorization: Bearer YOUR_JWT_TOKEN

Parameters

Parameter	Type	Description
sha	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

Field	Type	Description
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

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