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

ParameterTypeDescription
shaRequiredThe 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

FieldTypeDescription
shaStringThe commit SHA
noteStringThe note content
ref_shaStringCurrent 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

StatusDescription
404 Not FoundNote doesn’t exist for the specified commit
401 UnauthorizedInvalid JWT or missing git:read scope
400 Bad RequestMissing sha parameter