Skip to main content
GET
Notes Read

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sha
string
required

Git object SHA whose note should be fetched.

ref
string

Optional notes ref to read from. A bare name like reviews is placed under refs/notes/; a fully-qualified refs/notes/* ref is also accepted. Defaults to refs/notes/commits.

Response

The note stored for the requested Git object.

A single Git note attached to a commit, including the current notes ref tip.

note
string
required

The note content.

Example:

"Reviewed. Ready for production."

ref_sha
string
required

Current SHA of the notes ref the note was read from.

Example:

"0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492"

sha
string
required

The commit SHA.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"