repos.notes.refs.list

List Git notes refs under a notes ref prefix with cursor pagination. Use this to discover custom notes namespaces before reading individual notes.

Scope: git:read on the repository.

GET /api/repos/{repo_name}/notes/refs

TypeScript

TypeScript

import { Pierre } from '@pierre/sdk';

// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
const pierre = new Pierre();

for await (const ref of pierre.repos.notes.refs.list({
  repo_name: 'my-demo-repository',
  limit: 20,
  prefix: 'reviews/',
})) {
  console.log(ref);
}

200

{
  "has_more": true,
  "next_cursor": "MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY",
  "prefix": "refs/notes/reviews/",
  "refs": [
    {
      "cursor": "refs/notes/reviews/session-a",
      "ref": "refs/notes/reviews/session-a",
      "sha": "a1b2c3d4e5f6"
    }
  ]
}

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.

Path Parameters

repo_name · string · required

The repository name, for example acme/web.

Query Parameters

prefix · string

Notes ref prefix to enumerate. A bare prefix like reviews is placed under refs/notes/; a fully-qualified refs/notes/* prefix is also accepted. Defaults to refs/notes/.

cursor · string

Pagination cursor returned by a previous list_notes_refs response.

limit · integer · default: 20

Maximum number of notes refs to return. Defaults to 20.

Response

200

application/json

Notes refs in lexical order.

Paginated list of Git notes refs under the requested prefix.

has_more · boolean · required

Whether another page is available.

Example:

true

prefix · string · required

Normalized notes ref prefix used for the listing.

Example:

"refs/notes/reviews/"

refs · object[] · required

List of notes refs.

Show child attributes

next_cursor · string

Opaque cursor for the next page. Pass it as cursor to read the next page. Absent when there are no more results.

Example:

"MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY"