repos.commits.list

List commit history for the repository default branch or for an explicit branch. Results are cursor-paginated and ordered by commit date, newest first. Set path to restrict the history to commits that modified a specific file or subtree.

Scope: git:read on the repository.

GET /api/repos/{repo_name}/commits

TypeScript

TypeScript

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

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

for await (const commit of pierre.repos.commits.list({
  repo_name: 'my-demo-repository',
  limit: 20,
  path: 'docs/guide.md',
  ref: 'main',
})) {
  console.log(commit);
}

200

{
  "commits": [
    {
      "author_email": "[e-mail]",
      "author_name": "Jane Doe",
      "committer_date": "2024-01-16T09:05:41Z",
      "committer_email": "[e-mail]",
      "committer_name": "Jane Doe",
      "date": "2024-01-15T14:32:18Z",
      "message": "fix: resolve scrolling issue in dashboard",
      "parent_shas": [
        "f4f9df3b8db66c73f6bf67e8f8f4f14f6522731e"
      ],
      "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a",
      "signature": "-----BEGIN PGP SIGNATURE-----\n...\n-----END PGP SIGNATURE-----\n"
    }
  ],
  "has_more": true,
  "next_cursor": "MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY"
}

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

ref · string

Optional branch, tag, or commit to list commits from. When omitted, the repository default branch is used. Provide ref or the deprecated branch.

branch · string

Deprecated: use ref instead. Optional branch name to list commits from. When omitted, the repository default branch is used.

path · string

Optional repository-relative path to scope the history to commits that touched that path.

cursor · string

Pagination cursor returned by a previous list_commits response.

limit · integer · default: 20

Maximum number of commits to return. Defaults to 20.

ephemeral · boolean

Whether ref should be resolved from the ephemeral namespace.

Response

200

application/json

Commit history ordered from newest to oldest.

Paginated commit history for the repository, optionally filtered by branch.

commits · object[] · required

List of commit objects.

Show child attributes

has_more · boolean · required

Whether another page is available.

Example:

true

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"