repos.list

List repositories for the current organisation with cursor-based pagination. Supply q to filter results by a case-insensitive substring match against repo_name (for example pierre/sdk-documentation), and prefix to filter by the start of repo_name. When both are set they combine with AND: a repository is returned only when it matches both filters.

Scope: org:read.

GET /api/repos

TypeScript

TypeScript

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

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

for await (const repo of pierre.repos.list({
  limit: 20,
  prefix: 'pierre/',
  q: 'sdk',
})) {
  console.log(repo);
}

200

{
  "has_more": true,
  "next_cursor": "MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY",
  "repos": [
    {
      "created_at": "2024-01-15T10:30:00Z",
      "default_branch": "main",
      "repo_name": "team/project-alpha",
      "upstream": {
        "name": "Hello-World",
        "owner": "octocat",
        "provider": "github"
      }
    }
  ]
}

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

q · string

Case-insensitive substring to match against repo_name. Trimmed before matching. When prefix is also set, both must match (AND) and q only matches the part of repo_name after the prefix. When omitted or empty after trimming, the full repository list is returned.

prefix · string

Case-insensitive prefix to match against the start of repo_name. For example, pierre/ matches pierre/sdk-documentation and pierre/example but not acme/pierre-tools. When q is also set, both must match (AND) and q only matches the part of repo_name after the prefix, so prefix=pierre/&q=sdk returns pierre/sdk-documentation but not pierre/example. Trimmed before matching. When omitted or empty after trimming, no prefix filter applies.

cursor · string

Pagination cursor from previous response (base64 encoded)

limit · integer · default: 20

Maximum number of repositories to return. Defaults to 20 and is capped at 100.

Required range: 1 <= x <= 100

Response

200

application/json

A paginated view of repositories in the organisation.

Paginated list of repositories for the current organisation.

has_more · boolean · required

Whether another page is available.

Example:

true

repos · object[] · required

Repositories in the current page.

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"