Get Note

Read the Git note attached to a commit or other Git object SHA. Notes let you store review status, handoff details, or other context without changing repository contents.

JWT claims

Required scopes: git:read
Requires per repo scope: Yes

Deprecated: Use /api/repos/{repo_name}/notes instead.

GET /api/v1/repos/notes

Get Note

cURL

curl --request GET \
  --url https://api.{cluster}.code.storage/api/v1/repos/notes \
  --header 'Authorization: Bearer <token>'

200

{
  "note": "Reviewed. Ready for production.",
  "ref_sha": "0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492",
  "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}

Authorizations

Authorization · string · header · required

JWT bearer token signed with your organization's registered signing key. There is no OAuth authorization server; you mint tokens yourself and the token's scopes claim carries the granted permission scopes. Public scopes: git:read (read repository contents), git:write (write branches, commits, tags, and notes), repo:write (create and manage repositories), org:read (list an organization's repositories). Each operation's security requirement names the scopes it requires. See https://code.storage/docs/getting-started/authentication for how to mint tokens.

Query Parameters

object_ref · string

Git object whose note should be fetched. A full object SHA today. Provide object_ref or the deprecated sha.

sha · string

Deprecated: use object_ref instead. Git object SHA whose note should be fetched.

notes_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. Provide notes_ref or the deprecated ref.

ref · string

Deprecated: use notes_ref instead. Optional notes ref to read from. Defaults to refs/notes/commits.

Response

200

application/json

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"